全部产品
存储与CDN 数据库 域名与网站(万网) 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网 钉钉智能硬件
阿里云SDK开发指南

使用CommonRequest进行调用

更新时间:2018-02-02 15:52:00

Common调用方式

当您需要访问的API没有产品SDK提供时。可以采用泛用型的API调用方式,使用CommonRequest,实现任意OpenAPI接口的调用,CommonReques有如下特点:

  1. 轻量:只需Core包即可发起调用,无需下载安装各产品线SDK。
  2. 简便:无需更新SDK即可调用最新发布的API。
  3. 快速迭代

开始使用

请配合相应的API文档使用,以查询API的相关信息。您可以在 文档中心 查询到所有产品的API文档。发起一次Common请求,需要您查询到以下几个参数:

  • 域名(domain):即该产品的通用访问域名,一版可以在”调用方式”页查看到
  • API版本(version):该API的版本号,以’YYYY-MM-DD’的形式表现,一般可以在”公共参数”页面查到

在”公共参数”页面中,version字段一般以Version参数体现,部分页面以x-acs-version参数体现

  • 当调用的OpenAPI为Rpc风格时(大部分阿里云产品OpenAPI为Rpc风格),例如:ECS、RDS,需要赋值以下字段:
    • Action字段,例如ECS-RunInstances 的Action为RunInstances使用request.setAction("<Action>");来指定API名称
  • 当调用的OpenAPI风格为Restful风格接口时,例如:CS(容器服务), 需要赋值以下字段:

    Tips: 如何区分Rpc风格和Restful风格

    • 简单来说,API参数中,包含Action字段的是RPC风格,需要PathPattern的是Restful风格。
    • 一般情况下,每个产品内,所有API的调用风格是统一的
    • 每个API仅支持特定的一种风格调用,传入错误的标识,可能会调用到其他API,或收到“ApiNotFound”的错误信息

OpenAPI Explorer

部分产品,您也可以通过https://api.aliyun.com来获取API的参数信息。

代码示例

调用Rpc风格的接口

我们以Ecs产品的DescribeInstanceStatus API为例

该接口信息也可以在OpenAPI Explorer - DescribeInstanceStatus中找到

  1. import com.aliyuncs.CommonRequest;
  2. import com.aliyuncs.CommonResponse;
  3. import com.aliyuncs.DefaultAcsClient;
  4. import com.aliyuncs.IAcsClient;
  5. import com.aliyuncs.exceptions.ClientException;
  6. import com.aliyuncs.exceptions.ServerException;
  7. import com.aliyuncs.profile.DefaultProfile;
  8. public class Sample {
  9. public static void main(String[] args) {
  10. // 创建DefaultAcsClient实例并初始化
  11. DefaultProfile profile = DefaultProfile.getProfile(
  12. "<your-region-id>", // 您的地域ID
  13. "<your-access-key-id>", // 您的Access Key ID
  14. "<your-access-key-secret>"); // 您的Access Key Secret
  15. IAcsClient client = new DefaultAcsClient(profile);
  16. // 创建API请求并设置参数
  17. CommonRequest request = new CommonRequest();
  18. request.setDomain("ecs.aliyuncs.com");
  19. request.setVersion("2014-05-26");
  20. request.setAction("DescribeInstanceStatus");
  21. request.putQueryParameter("PageNumber", "1");
  22. request.putQueryParameter("PageSize", "30");
  23. try {
  24. CommonResponse response = client.getCommonResponse(request);
  25. System.out.println(response.getData());
  26. } catch (ServerException e) {
  27. // TODO Auto-generated catch block
  28. e.printStackTrace();
  29. } catch (ClientException e) {
  30. // TODO Auto-generated catch block
  31. e.printStackTrace();
  32. }
  33. }
  34. }

调用Restful风格的接口

我们以容器服务的查看所有集群实例为例

  1. import com.aliyuncs.CommonRequest;
  2. import com.aliyuncs.CommonResponse;
  3. import com.aliyuncs.DefaultAcsClient;
  4. import com.aliyuncs.IAcsClient;
  5. import com.aliyuncs.exceptions.ClientException;
  6. import com.aliyuncs.exceptions.ServerException;
  7. import com.aliyuncs.profile.DefaultProfile;
  8. public class Sample {
  9. public static void main(String[] args) {
  10. // 创建DefaultAcsClient实例并初始化
  11. DefaultProfile profile = DefaultProfile.getProfile(
  12. "<your-region-id>", // 您的地域ID
  13. "<your-access-key-id>", // 您的Access Key ID
  14. "<your-access-key-secret>"); // 您的Access Key Secret
  15. IAcsClient client = new DefaultAcsClient(profile);
  16. // 创建API请求并设置参数
  17. CommonRequest request = new CommonRequest();
  18. request.setDomain("cs.aliyuncs.com");
  19. request.setVersion("2015-12-15");
  20. request.setUriPattern("/clusters");
  21. try {
  22. CommonResponse response = client.getCommonResponse(request);
  23. System.out.println(response.getData());
  24. } catch (ServerException e) {
  25. // TODO Auto-generated catch block
  26. e.printStackTrace();
  27. } catch (ClientException e) {
  28. // TODO Auto-generated catch block
  29. e.printStackTrace();
  30. }
  31. }
  32. }
本文导读目录