接口規(guī)范
更新時(shí)間:
本文介紹SDK接口需要遵循的原則。
Request-Response原則
盡管不同語言的SDK實(shí)現(xiàn)有所不同,但其接口都遵循Request-Response原則,即對API的調(diào)用按照如下方式進(jìn)行:
利用請求參數(shù)構(gòu)建相應(yīng)的Request實(shí)例。
調(diào)用SDK中的相應(yīng)接口并傳入上一步的Request實(shí)例。
SDK接口的返回結(jié)果以相應(yīng)的Response實(shí)例返回給用戶。
示例
以下代碼片段展示了如何分頁獲取資源管理下的所有設(shè)備列表。
// 1 創(chuàng)建Config實(shí)例并初始化。
Config authConfig = new Config();
/**
* 阿里云賬號AccessKey擁有所有API的訪問權(quán)限,建議您使用RAM用戶進(jìn)行API訪問或日常運(yùn)維。
* 強(qiáng)烈建議不要把AccessKey ID和AccessKey Secret保存到工程代碼里,否則可能導(dǎo)致AccessKey泄露,威脅您賬號下所有資源的安全。
* 調(diào)用接口前請先配置身份認(rèn)證,具體操作請參見http://bestwisewords.com/document_detail/378657.html。
* 本示例使用了阿里云Credentials工具托管AccessKey,來實(shí)現(xiàn)API訪問的身份驗(yàn)證。
*/
com.aliyun.credentials.Client credentialClient = new com.aliyun.credentials.Client();
authConfig.endpoint = "region_endpoint"; //在實(shí)際使用中,請按照您實(shí)際的服務(wù)入口和接入方式編寫。
authConfig.regionId = "cn-hangzhou"; //在實(shí)際使用中,請按照您實(shí)際的服務(wù)地域編寫。
authConfig.setCredential(credentialClient);
Client authClient = new Client(authConfig);
// 2 創(chuàng)建API請求并設(shè)置參數(shù)。
//初始化ListDevices的請求類。
ListDevicesRequest request = new ListDevicesRequest();
request.setMaxResults(10); //分頁參數(shù),每頁獲取10行。
request.setDeviceFormName("網(wǎng)絡(luò)設(shè)備"); //設(shè)備形態(tài)名稱,在實(shí)際使用中,請按照您實(shí)際設(shè)備形態(tài)編寫。
//使用request實(shí)例調(diào)用ListDevices接口,且返回參數(shù)為對應(yīng)的Response實(shí)例。
ListDevicesResponse response = authClient.listDevices(request);
//其他代碼。
文檔內(nèi)容是否對您有幫助?