SDK接口的接口规范是什么_云网管(CMN)-阿里云帮助中心

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

Request-Response原则

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

利用请求参数构建相应的Request实例。
调用SDK中的相应接口并传入上一步的Request实例。
SDK接口的返回结果以相应的Response实例返回给用户。

示例

以下代码片段展示了如何分页获取资源管理下的所有设备列表。

// 1 创建Config实例并初始化。
Config authConfig = new Config();
/**
 *  阿里云账号AccessKey拥有所有API的访问权限，建议您使用RAM用户进行API访问或日常运维。
 *  强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里，否则可能导致AccessKey泄露，威胁您账号下所有资源的安全。
 *  调用接口前请先配置身份认证，具体操作请参见https://help.aliyun.com/document_detail/378657.html。
 *  本示例使用了阿里云Credentials工具托管AccessKey，来实现API访问的身份验证。
 */
com.aliyun.credentials.Client credentialClient = new com.aliyun.credentials.Client();
authConfig.endpoint = "region_endpoint"; //在实际使用中，请按照您实际的服务入口和接入方式编写。
authConfig.regionId = "cn-hangzhou"; //在实际使用中，请按照您实际的服务地域编写。
authConfig.setCredential(credentialClient);
Client authClient = new Client(authConfig);

// 2 创建API请求并设置参数。
//初始化ListDevices的请求类。
ListDevicesRequest request = new ListDevicesRequest();
request.setMaxResults(10);  //分页参数，每页获取10行。
request.setDeviceFormName("网络设备");  //设备形态名称，在实际使用中，请按照您实际设备形态编写。
//使用request实例调用ListDevices接口，且返回参数为对应的Response实例。
ListDevicesResponse response = authClient.listDevices(request);
//其他代码。