赛尔校园公共服务平台 Logo
平台使用
阿里云
百度云
移动云
智算服务
教育生态
登录 →
赛尔校园公共服务平台 Logo
平台使用 阿里云 百度云 移动云 智算服务 教育生态
登录
  1. 首页
  2. 阿里云
  3. 日志服务
  4. 开发参考
  5. 日志服务SDK
  6. 接口规范

接口规范

  • 日志服务SDK
  • 发布于 2025-04-22
  • 0 次阅读
文档编辑
文档编辑

本文介绍SDK接口需要遵循的原则。

Request-Response原则

尽管不同语言的SDK实现有所不同,但其接口都遵循Request-Response原则,即对API的调用按照如下方式进行:

  1. 利用请求参数构建相应的Request实例。

  2. 调用SDK中的相应接口并传入上一步的Request实例。

  3. SDK接口的返回结果以相应的Response实例返回给用户。

示例

以下代码片段展示了如何获取一个Project下的所有Logstore的名称。

// 其他代码。
// 本示例从环境变量中获取AccessKey ID和AccessKey Secret。
String accessId = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
String accessKey = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
// Project名称。   
String project = "your_project";
// 日志服务的服务接入点。
String endpoint = "region_endpoint";
// 构建一个Client实例。
Client client = new Client(endpoint, accessId, accessKey);
// 用请求参数project初始化ListLogstores的请求类。
ListLogStoresRequest lsRequest = new ListLogStoresRequest(project, 0,100, "");
// 使用request实例调用ListLogstores接口,且返回参数为对应的Response实例。
ListLogStoresResponse res = client.ListLogStores(lsRequest);
// 访问Response实例获取请求结果。
ArrayList<String> names = res.GetLogStores();
// 其他代码。
// 其他代码。
// 本示例从环境变量中获取AccessKey ID和AccessKey Secret。
String accessId = Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_ID"); 
String accessKey = Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
// Project名称。
String project = "your_project";
// 日志服务的服务接入点。
String endpoint = "region_endpoint";
// 构建一个Client实例。
SLSClient client = new SLSClient(endpoint, accessId, accessKey);
// 用请求参数project初始化ListLogstores的请求类。
ListLogStoresRequest lsRequest = new ListLogStoresRequest();
lsRequest.Project = project;
// 使用request实例调用ListLogstores接口,且返回参数为对应的Response实例。
ListLogStoresResponse res = client.ListLogStores(lsRequest);
// 访问Response实例获取请求结果。
List<String> names = res.Logstores;
// 其他代码。
// 其他代码。
// 本示例从环境变量中获取AccessKey ID和AccessKey Secret。
$accessId = getenv('ALIBABA_CLOUD_ACCESS_KEY_ID'); 
$accessKey = getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET');
// Project名称。
$project = "your_project";
// 日志服务的接入点。
$endpoint = "region_endpoint";
// 构建一个Client实例。
$client = new Aliyun_Sls_Client($endpoint, $accessId, $accessKey);
// 用请求参数project初始化ListLogstores的请求类。
$request = new Aliyun_Sls_Models_ListLogstoresRequest($project);
// 使用request实例调用ListLogstores接口,且返回参数为对应Response实例。
$response = $client->listLogstores($request);
// 访问Response实例获取请求结果。
$names = $response->getLogstores();
// 其他代码。
# 其他代码。
# 本示例从环境变量中获取AccessKey ID和AccessKey Secret。
accessId = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_ID', '');
accessKey = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_SECRET', '');
# Project名称。
project = 'your_project'; 
# 日志服务的服务接入点。
endpoint = 'region_endpoint';
# 构建一个Client。
client = LogClient(endpoint, accessId, accessKey)
# 用请求参数project初始化ListLogstores的请求类。
lsRequest = ListLogstoresRequest(project)
# 使用request实例调用ListLogstores接口,且返回参数为对应的Response实例。
res = client.list_logstores(lsRequest)
# 访问Response实例获取请求结果。
names = res.get_logstores();
# 其他代码。

SDK实现了多组类似ListLogStores的接口,也定义了相应的Request和Response类。除去Request-Response风格的基础接口外,各个不同语言的SDK还会提供一些包装了这些基础接口的辅助接口,使您无需自己构建Request及解析最终Response内容。更多信息,请参见SDK参考。

相关文章

SDK参考概述 2025-04-22 10:36

开发人员可以使用.NET Core、Java、Python、PHP、Node.js、C、Go、iOS、Android、C++等语言的SDK采集、查询和分析日志等。

配置访问凭证 2025-04-22 10:36

使用SDK发起请求访问日志服务,您需要配置访问凭证。阿里云服务会通过访问凭证验证您的身份信息和访问权限。您可以根据使用场景对认证和授权的要求,配置不同类型的访问凭证。 访问凭证 访问凭证选型 凭据是指用户证明其身

错误处理 2025-04-22 10:36

在使用SDK访问日志服务端时,可能会出现网络中断、网络延迟导致的请求失败。本文介绍SDK请求失败时的错误处理逻辑。 错误类型及处理原则

接口规范 2025-04-22 10:36

本文介绍SDK接口需要遵循的原则。 Request-Response原则 尽

数据压缩 2025-04-22 10:36

lz4是一种无损压缩算法,具有高速解码与压缩能力。日志服务部分API接口支持lz4压缩算法,使用lz4压缩算法可以减少网络传输流量,降低流量费用,提升接口访问速度。 压缩请求数据

获取RequestId 2025-04-22 10:36

本文以Java、Python和Go语言为例,介绍如何获取日志服务请求的RequestId。 说明 本文的代码是通过GetProject - 获取指定Project接口,分别介绍三种语言如何

目录
Copyright © 2025 your company All Rights Reserved. Powered by 赛尔网络.
京ICP备14022346号-15
gongan beian 京公网安备11010802041014号