接口规范

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

Request-Response原则

尽管不同语言的SDK实现有所不同,但其接口都遵循Request-Response原则,即对API的调用按照如下方式进行:
  1. 利用请求参数构建相应的Request实例。

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

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

示例

以下代码片段展示了如何分页获取资源管理下的所有设备列表。
        // 1 创建Config实例并初始化。
        Config authConfig = new Config();
        authConfig.accessKeyId = "your_access_id";     //用您的真实阿里云AccessKeyId替代。
        authConfig.accessKeySecret = "your_access_key";   //用您的真实阿里云AccessKeySecret替代。
        authConfig.endpoint = "region_endpoint"; //在实际使用中,请按照您实际的服务入口和接入方式编写。
        authConfig.regionId = "cn-hangzhou"; //在实际使用中,请按照您实际的服务地域编写。

        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);
         //其他代码