Java SDK通用流程及示例

步骤一：安装弹性伸缩的Java SDK

1. 通过以下任一方式在IDEA中配置Maven项目管理工具。

   • 方式一：使用IDEA中集成的Maven项目管理工具。

   • 方式二：访问Maven官方下载页面（Download Apache Maven）下载对应操作系统的Maven工具，手动配置Maven工具。

2. 访问阿里云开发工具包（SDK），选择云产品为弹性伸缩，获取阿里云的SDK核心库和弹性伸缩的Maven项目依赖。

3. 通过以下任一方式创建Maven项目。

   • 方式一：在IDEA中添加一个Maven项目。

   • 方式二：将已有的项目转换为Maven项目。

     1. 右键单击要转换的项目，并选择Add Framework Support...。

     2. 选择Maven，并单击OK。

4. 在项目目录下的pom.xml文件中新建 <dependencies></dependencies>标签，在该标签中添加以下依赖。

   添加依赖后，点击右上角刷新按钮，或者右键项目名称，选择Maven > Reload project，下载Maven依赖到项目中。

   说明

   SDK包更新频繁，建议您通过阿里云开发工具包（SDK）官网获取最新版本依赖。

   <dependency>
     <groupId>com.aliyun</groupId>
     <artifactId>tea-openapi</artifactId>
     <version>0.2.8</version>
   </dependency>
   <dependency>
     <groupId>com.aliyun</groupId>
     <artifactId>ess20220222</artifactId>
     <version>1.5.2</version>
   </dependency>
   <dependency>
     <groupId>com.aliyun</groupId>
     <artifactId>credentials-java</artifactId>
     <version>0.2.11</version>
   </dependency>

步骤二：编写Java SDK的通用流程

本步骤以弹性伸缩Java SDK查询伸缩组内ECS实例列表的方法DescribeScalingInstances为例，介绍编写弹性伸缩Java SDK的通用操作流程。

1. 通过Credentials工具从环境变量中获取AccessKey信息。

   代码如下所示：

   com.aliyun.credentials.Client credentialClient = new com.aliyun.credentials.Client();
   com.aliyun.teaopenapi.models.Config config = new Config();
   config.setCredential(credentialClient);
   config.setEndpoint("ess.aliyuncs.com");

2. 生成Client的对象client。

   代码如下所示：

   com.aliyun.ess20220222.Client client = new com.aliyun.ess20220222.Client(config);

3. 创建一个对应方法的Request，使用构造函数生成一个默认的请求类request。

   类的命名规则为API方法名加上Request。例如，查询伸缩组内ECS实例列表的API方法名为DescribeScalingInstances，则对应的请求类的名称为DescribeScalingInstancesRequest。

   DescribeScalingInstancesRequest request = new DescribeScalingInstancesRequest();

4. 设置请求类request的参数。

   通过request类的setXxx方法设置必要的信息，即API中必须要设置的参数信息，通过setXxx方法设置参数。示例中：

   • DescribeScalingInstances的API方法RegionId用来指定地域。

   • DescribeScalingInstances的API方法InstanceId用来设置待查询的伸缩组内ECS实例ID。设置setInstanceId的值为i-bp15itgtxemxy7v9****，表示查询的伸缩组内ECS实例ID为i-bp15itgtxemxy7v9****。

   request.setInstanceId("i-bp15itgtxemxy7v9****");

5. 通过调用client对象的describeScalingInstancesWithOptions方法获得对应request响应结果。

   代码如下所示：

   com.aliyun.teautil.models.RuntimeOptions runtime = new com.aliyun.teautil.models.RuntimeOptions();
   DescribeScalingInstancesResponse response = client.describeScalingInstancesWithOptions(request,runtime);

   说明

   您可以进入弹性伸缩_SDK中心-阿里云OpenAPI开发者门户 (aliyun.com)，选择Java页签 > 快速入门 > 步骤介绍，了解详细流程。

完整代码示例

以下为本文示例的完整Java SDK代码。

import com.aliyun.ess20220222.models.DescribeScalingInstancesRequest;
import com.aliyun.ess20220222.models.DescribeScalingInstancesResponse;
import com.aliyun.teaopenapi.models.Config;
import com.google.gson.Gson;
import java.util.ArrayList;
import java.util.List;

public class DescribeScalingInstances {
    public static void main(String[] args) throws Exception {
        com.aliyun.credentials.Client credentialClient = new com.aliyun.credentials.Client();
        com.aliyun.teaopenapi.models.Config config = new Config();
        config.setCredential(credentialClient);
        config.setEndpoint("ess.aliyuncs.com");
        com.aliyun.ess20220222.Client client = new com.aliyun.ess20220222.Client(config);
        DescribeScalingInstancesRequest request = new DescribeScalingInstancesRequest();
        request.setRegionId("cn-hangzhou");
        request.setScalingGroupId("asg-XXXXXXXX");
        request.setScalingConfigurationId("asc-XXXXXXXXX");
        request.setPageNumber(1);
        request.setPageSize(10);

        List<String> instanceIdList = new ArrayList<String>();
        instanceIdList.add("i-XXXXXX");
        request.setInstanceIds(instanceIdList);
        com.aliyun.teautil.models.RuntimeOptions runtime = new com.aliyun.teautil.models.RuntimeOptions();
        DescribeScalingInstancesResponse response = client.describeScalingInstancesWithOptions(request,runtime);
        System.out.println(new Gson().toJson(response));
    }
}

执行结果

全部返回信息如下所示：

{
    "TotalCount": 2,
    "RequestId": "5E65F238-4B45-54B6-BE15-A34956FA0D96",
    "PageSize": 10,
    "PageNumber": 1,
    "ScalingInstances": {
        "ScalingInstance": [
            {
                "LoadBalancerWeight": 50,
                "CreatedTime": "2022-04-27T03:24:58Z",
                "WarmupState": "NoNeedWarmup",
                "ZoneId": "cn-hangzhou-i",
                "InstanceId": "i-bp1h3dog530vvnqm****",
                "ScalingActivityId": "asa-bp16rgo6477ojn3u****",
                "ScalingGroupId": "asg-bp10uuhy2wbb2tip****",
                "CreationTime": "2022-04-27T03:24Z",
                "HealthStatus": "Healthy",
                "LifecycleState": "Protected",
                "Entrusted": false,
                "CreationType": "Attached"
            },
            {
                "LoadBalancerWeight": 50,
                "CreatedTime": "2022-04-27T06:38:21Z",
                "ZoneId": "cn-hangzhou-i",
                "InstanceId": "i-bp15itgtxemxy7v9****",
                "ScalingActivityId": "asa-bp1ejteup0bntltl****",
                "ScalingGroupId": "asg-bp10uuhy2wbb2tip****",
                "HealthStatus": "Healthy",
                "LifecycleState": "Stopped",
                "CreationType": "AutoCreated",
                "WarmupState": "NoNeedWarmup",
                "CreationTime": "2022-04-27T06:38Z",
                "Entrusted": true,
                "ScalingConfigurationId": "asc-bp1433dp4gktwkmi****"
            }
        ]
    },
    "TotalSpotCount": 0
}

步骤一：获取SDK示例代码

您可以通过阿里云的OpenAPI门户，调用弹性伸缩API自动生成SDK示例代码。

1. 单击OpenAPI门户。

2. 参考图中示例步骤下载完整的SDK工程。下载完后完成解压。

步骤二：运行SDK示例代码

1. 使用IntelliJ IDEA，单击File->Open，选择解压后的工程文件夹，等待Maven自动安装依赖信息。

2. 运行示例代码。

   双击打开Sample，确认无报错后，运行代码。

3. 查看运行结果。

   在弹性伸缩管理控制台 (aliyun.com)查看新创建的伸缩组。

完整代码示例

使用Java SDK创建伸缩组的完整参考示例，请参见Java SDK示例。