AI 助理
文档备案控制台
开发者社区 云服务技术课堂 文章 正文

阿里云日志服务Rest API使用示例参考

2020-04-03 646
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 本次分享主要介绍CreateProject、DeleteProject和ListLogstore三个API的使用示例，相关示例使用JAVA语言。

作者：俏巴

概述

日志服务（Log Service，简称 LOG）是针对日志类数据的一站式服务，在阿里巴巴集团经历大量大数据场景锤炼而成。用户除了通过管理控制台进行操作外，LOG 还提供了 API（Application Programming Interface）方式写入、查询日志数据，管理自己的项目及日志库等。在实际的开发使用过程中，我们建议用户使用官方提供的最新版SDK。直接使用Rest API相对比较麻烦，特别是在签名的生成过程中很容易出错，且不易排查。下面主要介绍CreateProject、DeleteProject和ListLogstore三个API的使用示例，相关示例使用JAVA语言。

相关依赖

<dependency>
            <groupId>org.apache.httpcomponents</groupId>
            <artifactId>httpclient</artifactId>
            <version>4.4</version>
</dependency>

示例代码

CreateProject
import net.sf.json.JSONObject;
import org.apache.commons.codec.binary.Base64;
import java.math.BigInteger;
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import java.io.UnsupportedEncodingException;
import java.security.InvalidKeyException;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Locale;
import java.util.TimeZone;

//创建project操作
public class CreateProject {

    public static void main(String[] args){

        //获取GMT英文格式时间
        Date d=new Date();
        DateFormat format=new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss z",Locale.ENGLISH);//英文格式的时间转换时需要带上Locale.ENGLISH，否则会转换失败，因为它默认的是本地化的设置，除非你的操作系统是英文的，总之时间转换时需要时间格式与模式保持一致。
        format.setTimeZone(TimeZone.getTimeZone("GMT"));
        String date = format.format(d);

        //参数设置
        String projectName = "restapiproject";//日志服务项目名称
        String projectDescription = "sample_demo";//日志服务项目描述
        String AccessKeySecret = "********";//Access Key Secret
        String AccessKeyId = "********";//AccessKey ID

        JSONObject jsonBody = new JSONObject();
        jsonBody.put("projectName", projectName);
        jsonBody.put("description", projectDescription);

        //构造请求body
        String body = jsonBody.toString();
        System.out.println("jsonBody: " + jsonBody.toString());
        String md5 = md5(body).toUpperCase();
        md5 = md5.toUpperCase();//小写字母转大写

        //构造签名String
        String SignString = "POST\n" +
                md5+"\n"+
                "application/json\n" +
                date + "\n"+
                "x-log-apiversion:0.6.0\n" +
                "x-log-bodyrawsize:0\n" +
                "x-log-signaturemethod:hmac-sha1\n" + "/";

        String sign = encode(AccessKeySecret,SignString);

        String Authorization = "LOG " + AccessKeyId + ":" + sign;
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("http://"+projectName+".cn-qingdao.log.aliyuncs.com");//在青岛区域创建Project
            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Authorization", Authorization);
            request.setHeader("Date", date);
            request.setHeader("Host", projectName + ".cn-qingdao.log.aliyuncs.com");
            request.setHeader("x-log-apiversion", "0.6.0");
            request.setHeader("x-log-signaturemethod", "hmac-sha1");
            request.setHeader("Content-Type","application/json");
            request.setHeader("User-Agent","sls-java-sdk-v-0.6.1");
            request.setHeader("x-log-bodyrawsize","0");
            request.setHeader("Content-MD5", md5);

            // Request body
            StringEntity reqEntity = new StringEntity(body,"UTF-8");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null)
            {
                System.out.println("项目创建成功！");
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println("error");
            System.out.println(e.getMessage());
        }
    }

    //写一个md5加密的方法
    public static String md5(String plainText) {
        //定义一个字节数组
        byte[] secretBytes = null;
        try {
            // 生成一个MD5加密计算摘要
            MessageDigest md = MessageDigest.getInstance("MD5");
            //对字符串进行加密
            md.update(plainText.getBytes());
            //获得加密后的数据
            secretBytes = md.digest();
        } catch (NoSuchAlgorithmException e) {
            throw new RuntimeException("没有md5这个算法！");
        }
        //将加密后的数据转换为16进制数字
        String md5code = new BigInteger(1, secretBytes).toString(16);// 16进制数字
        // 如果生成数字未满32位，需要前面补0
        for (int i = 0; i < 32 - md5code.length(); i++) {
            md5code = "0" + md5code;
        }
        return md5code;
    }

    //计算签名
    public static String encode(String accessKey, String data) {
        try {
            byte[] keyBytes = accessKey.getBytes("UTF-8");
            byte[] dataBytes = data.getBytes("UTF-8");
            Mac mac = Mac.getInstance("HmacSHA1");
            mac.init(new SecretKeySpec(keyBytes, "HmacSHA1"));
            return new String(Base64.encodeBase64(mac.doFinal(dataBytes)));
        } catch (UnsupportedEncodingException var5) {
            throw new RuntimeException("Not supported encoding method UTF-8", var5);
        } catch (NoSuchAlgorithmException var6) {
            throw new RuntimeException("Not supported signature method hmac-sha1", var6);
        } catch (InvalidKeyException var7) {
            throw new RuntimeException("Failed to calculate the signature", var7);
        }
    }
}

Delete Project

import org.apache.commons.codec.binary.Base64;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpDelete;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import java.io.UnsupportedEncodingException;
import java.math.BigInteger;
import java.net.URI;
import java.security.InvalidKeyException;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Locale;
import java.util.TimeZone;

//删除project的操作
public class DeleProject {

    public static void main(String[] args){

        //获取GMT英文格式时间
        Date d=new Date();
        DateFormat format=new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss z",Locale.ENGLISH);//英文格式的时间转换时需要带上Locale.ENGLISH，否则会转换失败，因为它默认的是本地化的设置，除非你的操作系统是英文的，总之时间转换时需要时间格式与模式保持一致。
        format.setTimeZone(TimeZone.getTimeZone("GMT"));
        String date = format.format(d);

        String AccessKeySecret = "********";
        String AccessKeyId = "********";
        String projectName = "restapiproject";//删除的project名称

        String SignString = "DELETE\n" +
                "\n"+
                "application/x-protobuf\n" +
                date + "\n"+
                "x-log-apiversion:0.6.0\n" +
                "x-log-bodyrawsize:0\n" +
                "x-log-signaturemethod:hmac-sha1\n"+"/";

        String sign = encode(AccessKeySecret,SignString);
        String Authorization = "LOG " + AccessKeyId + ":" + sign;
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("http://"+projectName+".cn-qingdao.log.aliyuncs.com/");
            URI uri = builder.build();
            HttpDelete request = new HttpDelete(uri);

            request.setHeader("Authorization", Authorization);
            request.setHeader("Date", date);
            request.setHeader("Host", projectName + ".cn-qingdao.log.aliyuncs.com");
            request.setHeader("x-log-apiversion", "0.6.0");
            request.setHeader("x-log-signaturemethod", "hmac-sha1");
            request.setHeader("Content-Type","application/x-protobuf");
            request.setHeader("User-Agent","sls-java-sdk-v-0.6.1");
            request.setHeader("x-log-bodyrawsize","0");

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null)
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }

    //写一个md5加密的方法
    public static String md5(String plainText) {
        //定义一个字节数组
        byte[] secretBytes = null;
        try {
            // 生成一个MD5加密计算摘要
            MessageDigest md = MessageDigest.getInstance("MD5");
            //对字符串进行加密
            md.update(plainText.getBytes());
            //获得加密后的数据
            secretBytes = md.digest();
        } catch (NoSuchAlgorithmException e) {
            throw new RuntimeException("没有md5这个算法！");
        }
        //将加密后的数据转换为16进制数字
        String md5code = new BigInteger(1, secretBytes).toString(16);// 16进制数字
        // 如果生成数字未满32位，需要前面补0
        for (int i = 0; i < 32 - md5code.length(); i++) {
            md5code = "0" + md5code;
        }
        return md5code;
    }

    public static String encode(String accessKey, String data) {
        try {
            byte[] keyBytes = accessKey.getBytes("UTF-8");
            byte[] dataBytes = data.getBytes("UTF-8");
            Mac mac = Mac.getInstance("HmacSHA1");
            mac.init(new SecretKeySpec(keyBytes, "HmacSHA1"));
            return new String(Base64.encodeBase64(mac.doFinal(dataBytes)));
        } catch (UnsupportedEncodingException var5) {
            throw new RuntimeException("Not supported encoding method UTF-8", var5);
        } catch (NoSuchAlgorithmException var6) {
            throw new RuntimeException("Not supported signature method hmac-sha1", var6);
        } catch (InvalidKeyException var7) {
            throw new RuntimeException("Failed to calculate the signature", var7);
        }
    }
}

ListLogstore

import org.apache.commons.codec.binary.Base64;
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import java.io.UnsupportedEncodingException;
import java.security.InvalidKeyException;
import java.security.NoSuchAlgorithmException;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Locale;
import java.util.TimeZone;

//列出指定项目Project下面的日志库
public class GetProjectLogstores {

    public static void main(String[] args){

        //获取GMT英文格式时间
        Date d=new Date();
        DateFormat format=new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss z",Locale.ENGLISH);//英文格式的时间转换时需要带上Locale.ENGLISH，否则会转换失败，因为它默认的是本地化的设置，除非你的操作系统是英文的，总之时间转换时需要时间格式与模式保持一致。
        format.setTimeZone(TimeZone.getTimeZone("GMT"));
        String date = format.format(d);

        //参数设置
        String projectName = "taroslproject";//项目名称
        String AccessKeySecret = "********";
        String AccessKeyId = "********";

        String SignString = "GET\n" +
                "\n" +
                "application/x-protobuf\n" +
                date + "\n"+
                "x-log-apiversion:0.6.0\n" +
                "x-log-bodyrawsize:0\n" +
                "x-log-signaturemethod:hmac-sha1\n" +
                "/logstores?logstoreName=&offset=0&size=100";

        String sign = encode(AccessKeySecret,SignString);
        String Authorization = "LOG " + AccessKeyId + ":" + sign;
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("http://"+projectName+".cn-qingdao.log.aliyuncs.com/logstores");
            builder.setParameter("offset", "0");
            builder.setParameter("size", "100");
            builder.setParameter("logstoreName", "");
            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Authorization", Authorization);
            request.setHeader("Date", date);
            request.setHeader("Host", projectName + ".cn-qingdao.log.aliyuncs.com");
            request.setHeader("x-log-apiversion", "0.6.0");
            request.setHeader("x-log-signaturemethod", "hmac-sha1");
            request.setHeader("Content-Length","0");
            request.setHeader("Content-Type","application/x-protobuf");
            request.setHeader("User-Agent","sls-java-sdk-v-0.6.1");
            request.setHeader("x-log-bodyrawsize","0");

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null)
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }

    }

    public static String encode(String accessKey, String data) {
        try {
            byte[] keyBytes = accessKey.getBytes("UTF-8");
            byte[] dataBytes = data.getBytes("UTF-8");
            Mac mac = Mac.getInstance("HmacSHA1");
            mac.init(new SecretKeySpec(keyBytes, "HmacSHA1"));
            return new String(Base64.encodeBase64(mac.doFinal(dataBytes)));
        } catch (UnsupportedEncodingException var5) {
            throw new RuntimeException("Not supported encoding method UTF-8", var5);
        } catch (NoSuchAlgorithmException var6) {
            throw new RuntimeException("Not supported signature method hmac-sha1", var6);
        } catch (InvalidKeyException var7) {
            throw new RuntimeException("Failed to calculate the signature", var7);
        }
    }
}

建议

在实际的使用过程中，当必须要直接使用Rest API，如果仅仅参考API的文档说明，测试出现问题的时候排查比较困难。目前Java语言的SDK实现了全部的API，建议可以参考Java SDK的源码编写自己的功能函数。

参考链接

API参考
Java SDK

文章标签：
日志服务
密钥管理服务
Java
开发工具
机器学习/深度学习
监控
数据安全/隐私保护
网络架构
API
算法
数据格式
JSON
相关实践学习
【涂鸦即艺术】基于云应用开发平台CAP部署AI实时生图绘板
【涂鸦即艺术】基于云应用开发平台CAP部署AI实时生图绘板
技术课堂的搬运工~
目录
相关文章
兵临天下19970108016
|
监控 供应链 API
速卖通商品 API，开发者示例
速卖通商品API是速卖通开放平台为开发者提供的接口，支持获取商品详情、订单管理等功能。具备多语言、多货币支持，适用于全球电商场景。可应用于商品分析、价格监控、竞品对比和库存管理等业务。文档提供Python调用示例，便于快速集成使用。
兵临天下19970108016
607 3
兵临天下19970108016
|
JSON API 数据格式
洋码头商品 API 示例指南（Python 实现）
洋码头是国内知名跨境电商平台，提供商品搜索、详情、分类等API接口。本文详解了使用Python调用这些API的流程与代码示例，涵盖签名生成、请求处理及常见问题解决方案，适用于构建选品工具、价格监控等跨境电商应用。
兵临天下19970108016
255 1
djy3xngakhsl4
|
缓存 JSON API
VIN车辆识别码查询车五项 API 实践指南：让每一俩车有迹可循（Python代码示例）
VIN（车辆识别代码）是全球唯一的17位汽车标识码，可快速获取车架号、发动机号、品牌型号等核心信息。在二手车交易、保险理赔、维修保养等场景中，准确解析VIN有助于提升效率与风控能力。本文介绍VIN码结构、适用场景，并提供Python调用示例及优化建议，助力企业实现车辆信息自动化核验。
djy3xngakhsl4
1783 1
技术交流18179014480
|
JSON API 数据格式
淘宝商品评论API接口，json数据示例参考
淘宝开放平台提供了多种API接口来获取商品评论数据，其中taobao.item.reviews.get是一个常用的接口，用于获取指定商品的评论信息。以下是关于该接口的详细介绍和使用方法：
技术交流18179014480
423 1
winx_19970108018
|
测试技术 API 开发者
淘宝关键词搜索商品列表API接入指南（含Python示例）
淘宝关键词搜索商品列表API是淘宝开放平台的核心接口，支持通过关键词检索商品，适用于比价、选品、市场分析等场景。接口提供丰富的筛选与排序功能，返回结构化数据，含商品ID、标题、价格、销量等信息。开发者可使用Python调用，需注意频率限制与错误处理，建议先在沙箱环境测试。
winx_19970108018
661 6
兵临天下19970108016
|
缓存 JSON API
淘宝关键词搜索 API 接口详解与示例
淘宝关键词搜索API（taobao.items.search）助力开发者高效获取商品数据，支持分页、筛选与排序。本文详解接口调用流程、签名机制及Python实现，涵盖权限申请、代码示例与常见问题解决方案，助你快速构建电商应用。
兵临天下19970108016
1547 5
兵临天下19970108016
|
JSON API 开发者
唯品会商品API，开发者示例
唯品会商品API支持获取商品详情、价格及库存信息，适用于开发者集成商品数据。通过如`vip.item_get`等接口，可使用Python等语言调用，实现商品信息查询与列表筛选。实际使用需申请官方授权或通过第三方平台接入，并遵守相关调用规则。
兵临天下19970108016
415 2
魔羯座liaotianfeile
|
JSON 监控 API
亚马逊Amazon商品详情API接口解析，josn数据参考
亚马逊商品详情API接口助力开发者高效获取商品信息，返回结构清晰的JSON数据，涵盖价格、描述、图片等关键字段。本文详解API调用方法与JSON格式，助您快速掌握商品数据抓取技巧，提升开发效率，适用于电商、数据分析等领域。
魔羯座liaotianfeile
1048 0
兵临天下19970108016
|
JSON API 开发者
一号店商品 API 示例指南（Python 实现）
本教程介绍如何使用 Python 调用一号店商品 API，涵盖商品搜索、详情、分类等接口的调用方法。内容包括注册认证、签名生成、代码实现及常见问题解决方案，并提供完整示例代码，帮助开发者快速接入一号店开放平台，构建电商工具与数据分析应用。
兵临天下19970108016
307 0
estar.lee
|
JSON API PHP
10多万语录随机一言API接口详解及调用示例
随机一言API可输出心灵鸡汤、至理名言等内容，适用于评论系统、签名生成等场景。完全免费，支持GET/POST请求。需注册获取专属ID和KEY，返回JSON格式数据，并提供PHP、Python调用示例。注意密钥安全与频率限制，内容版权归接口盒子所有。应用于每日推送、心情日记等多种场景。
estar.lee
1419 0

云服务技术课堂

热门文章

最新文章

  • 1
    浅析阿里云API网关的产品架构和常见应用场景
  • 2
    API网关为K8S容器应用集群提供强大的接入能力
  • 3
    淘宝、京东、拼多多电商API接口对比
  • 4
    通过 Java Vector API 利用 SIMD 的强大功能
  • 5
    openstack api
  • 6
    ArcGIS API for Silverlight 之ElementLayer使用及TextSymbol的模板使用
  • 7
    ArcGIS API for Silverlight 加载google地图
  • 8
    小红书笔记评论API数据解析（附代码）
  • 9
    海外http代理中的api代理是什么意思？使用方法有哪些？
  • 10
    使用commons-io-2.0 API来实现监听文件变化
  • 1
    【赵渝强老师】大数据日志采集引擎Flume
    595
  • 2
    16 倍性能提升，成本降低 98%！ 解读 SLS 向量索引架构升级改造
    814
  • 3
    防止员工泄密软件中文件访问日志管理的 Go 语言 B + 树算法
    371
  • 4
    局域网网络监控软件的设备连接日志哈希表 C++ 语言算法
    893
  • 5
    Python日志模块配置：从print到logging的优雅升级指南
    1011
  • 6
    SQL日志优化策略：提升数据库日志记录效率
    535
  • 7
    程序出错瞎找？教你写“会说话”的错误日志，秒定位原因
    783
  • 8
    SLS Copilot 实践：基于 SLS 灵活构建 LLM 应用的数据基础设施
    3493
  • 9
    EventLog Analyzer：高效的Web服务器日志监控与审计解决方案
    638
  • 10
    5 个 IIS 日志记录最佳实践
    612

    • 相关课程

    更多
  • 基于MongoDB构建实时日志分析平台
  • 日志服务SLS 构建可观测体系实战
  • 日志服务 SLS 可观测数据分析平台介绍
  • 大数据知识图谱系列—基于ELK+Flink日志全观测最佳实践
  • 场景实践-基于阿里云Quick BI 对MOOC网站日志分析

    • 相关电子书

    更多
  • Java Spring Boot开发实战系列课程【第15讲】：Spring Boot 2.0 API与Spring REST Docs实战
  • Spring Boot2.0实战Redis分布式缓存
  • CUDA MATH API

    • 相关实验场景

    更多
  • 通过日志服务实现云资源OSS的安全审计
  • 基于Assistant Api的旅游助手
  • 快速体验智能体API应用
    • 下一篇
    一条命令迁移，帮你实现 OpenClaw 与 Hermes Agent 记忆互通！