接口規(guī)范
更新時間：
本文介紹SDK接口需要遵循的原則。
Request-Response原則
盡管不同語言的SDK實現(xiàn)有所不同，但其接口都遵循Request-Response原則，即對API的調(diào)用按照如下方式進行：
利用請求參數(shù)構(gòu)建相應(yīng)的Request實例。
調(diào)用SDK中的相應(yīng)接口并傳入上一步的Request實例。
SDK接口的返回結(jié)果以相應(yīng)的Response實例返回給用戶。
示例
以下代碼片段展示了如何獲取一個Project下的所有Logstore的名稱。
// 其他代碼。
// 本示例從環(huán)境變量中獲取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";
// 日志服務(wù)的服務(wù)接入點。
String endpoint = "region_endpoint";
// 構(gòu)建一個Client實例。
Client client = new Client(endpoint, accessId, accessKey);
// 用請求參數(shù)project初始化ListLogstores的請求類。
ListLogStoresRequest lsRequest = new ListLogStoresRequest(project, 0,100, "");
// 使用request實例調(diào)用ListLogstores接口，且返回參數(shù)為對應(yīng)的Response實例。
ListLogStoresResponse res = client.ListLogStores(lsRequest);
// 訪問Response實例獲取請求結(jié)果。
ArrayList<String> names = res.GetLogStores();
// 其他代碼。// 其他代碼。
// 本示例從環(huán)境變量中獲取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";
// 日志服務(wù)的服務(wù)接入點。
String endpoint = "region_endpoint";
// 構(gòu)建一個Client實例。
SLSClient client = new SLSClient(endpoint, accessId, accessKey);
// 用請求參數(shù)project初始化ListLogstores的請求類。
ListLogStoresRequest lsRequest = new ListLogStoresRequest();
lsRequest.Project = project;
// 使用request實例調(diào)用ListLogstores接口，且返回參數(shù)為對應(yīng)的Response實例。
ListLogStoresResponse res = client.ListLogStores(lsRequest);
// 訪問Response實例獲取請求結(jié)果。
List<String> names = res.Logstores;
// 其他代碼。// 其他代碼。
// 本示例從環(huán)境變量中獲取AccessKey ID和AccessKey Secret。
$accessId = getenv('ALIBABA_CLOUD_ACCESS_KEY_ID');
$accessKey = getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET');
// Project名稱。
$project = "your_project";
// 日志服務(wù)的接入點。
$endpoint = "region_endpoint";
// 構(gòu)建一個Client實例。
$client = new Aliyun_Sls_Client($endpoint, $accessId, $accessKey);
// 用請求參數(shù)project初始化ListLogstores的請求類。
$request = new Aliyun_Sls_Models_ListLogstoresRequest($project);
// 使用request實例調(diào)用ListLogstores接口，且返回參數(shù)為對應(yīng)Response實例。
$response = $client->listLogstores($request);
// 訪問Response實例獲取請求結(jié)果。
$names = $response->getLogstores();
// 其他代碼。# 其他代碼。
# 本示例從環(huán)境變量中獲取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';
# 日志服務(wù)的服務(wù)接入點。
endpoint = 'region_endpoint';
# 構(gòu)建一個Client。
client = LogClient(endpoint, accessId, accessKey)
# 用請求參數(shù)project初始化ListLogstores的請求類。
lsRequest = ListLogstoresRequest(project)
# 使用request實例調(diào)用ListLogstores接口，且返回參數(shù)為對應(yīng)的Response實例。
res = client.list_logstores(lsRequest)
# 訪問Response實例獲取請求結(jié)果。
names = res.get_logstores();
# 其他代碼。SDK實現(xiàn)了多組類似ListLogStores的接口，也定義了相應(yīng)的Request和Response類。除去Request-Response風(fēng)格的基礎(chǔ)接口外，各個不同語言的SDK還會提供一些包裝了這些基礎(chǔ)接口的輔助接口，使您無需自己構(gòu)建Request及解析最終Response內(nèi)容。更多信息，請參見SDK參考。
文檔內(nèi)容是否對您有幫助？