全部产品
云市场

API 接入指南(SDK)

更新时间:2019-10-22 16:40:12

您可以使用 SDK 调用分布式任务调度 2.0 的 API,完成日常的管理操作。

获取SDK

在应用程序的pom.xml文件中添加 OpenAPI 的 SDK 依赖。

  1. <dependency>
  2. <groupId>com.aliyun</groupId>
  3. <artifactId>aliyun-java-sdk-schedulerx2</artifactId>
  4. <version>1.0.0</version>
  5. </dependency>
  6. <dependency>
  7. <groupId>com.aliyun</groupId>
  8. <artifactId>aliyun-java-sdk-core</artifactId>
  9. <version>4.3.3</version>
  10. </dependency>

子账号使用

您可以使用子账号(RAM)调用分布式任务调度 2.0 的 API,但需要先获取、配置子账号的 Access Key ID 和 Access Key Secret,并由主账号对子账号授予相应的资源的操作权限。

支持地域列表

在使用 SDK 调用 API 的时候需要用到地域的 Region ID、Domain 等信息,参见下面的表格。

注意:下表中 Domain(VPC)适用于没有公网的 VPC 的环境。

名称 RegionId Domain Domain(VPC)
华东1 cn-hangzhou schedulerx.cn-hangzhou.aliyuncs.com schedulerx-vpc.cn-hangzhou.aliyuncs.com
华南1 cn-shenzhen schedulerx.cn-shenzhen.aliyuncs.com schedulerx-vpc.cn-shenzhen.aliyuncs.com
华东2 cn-shanghai schedulerx.cn-shanghai.aliyuncs.com schedulerx-vpc.cn-shanghai.aliyuncs.com
华北2 cn-beijing schedulerx.cn-beijing.aliyuncs.com schedulerx-vpc.cn-beijing.aliyuncs.com

使用 SDK 调用 API

下面以一个通用的示例说明如何使用 SDK 调用 API。

  1. public static void main(String[] args) throws Exception{
  2. // OpenAPI 的接入点,具体参见支持地域列表和购买实例的地域
  3. String regionId = "XXXXX";
  4. //鉴权使用的 Access Key ID
  5. String accessKeyId = "XXXXXXXXXXXXXXXXX";
  6. //鉴权使用的 Access Key Secret
  7. String accessKeySecret = "XXXXXXXXXXXXXXXXX";
  8. //产品名称
  9. String productName ="schedulerx2";
  10. //参见支持地域列表,选择 Domain
  11. String domain ="schedulerx.xxxx.aliyuncs.com";
  12. //构建 OpenApi 客户端
  13. DefaultProfile.addEndpoint(regionId, productName, domain);
  14. DefaultProfile defaultProfile = DefaultProfile.getProfile(regionId, accessKeyId, accessKeySecret);
  15. DefaultAcsClient defaultAcsClient = new DefaultAcsClient(defaultProfile);
  16. //构建接口请求(根据接口中参数类型和是否必填进行填充)
  17. EnableJobRequest request = new EnableJobRequest();
  18. request.setJobId(jobId);
  19. request.setNamespace("xxxxxx");
  20. request.setGroupId("yyyyyy");
  21. //发送请求
  22. EnableJobResponse response = defaultAcsClient.getAcsResponse(request);
  23. if (!response.getSuccess()) {
  24. System.out.println(response.getMessage());
  25. System.out.println("EnableJob: "+response.getRequestId());
  26. }
  27. }