Elastic Compute Service:SDK を使用した ECS インスタンスの作成と使用

ステップ 1：VPC の作成

VPC は、クラウド内で論理的に分離されたプライベートネットワークです。

以下のパラメーターで CreateVpc を呼び出します。

CreateVpc を呼び出した後、次に進む前に VPC のステータスが Available になるまで DescribeVpcs をポーリングします。

ステップ 2：vSwitch の作成

vSwitch は VPC 内の ECS インスタンスを接続し、それらの間の通信を可能にします。

以下のパラメーターで CreateVSwitch を呼び出します。

ステップ 3：セキュリティグループの作成

セキュリティグループは仮想ファイアウォールとして機能し、ECS インスタンスのインバウンドおよびアウトバウンドトラフィックをコントロールします。

以下のパラメーターで CreateSecurityGroup を呼び出します。

次に、AuthorizeSecurityGroup を介してインバウンドルールを追加します。

ステップ 4：SSH キーペアの作成

SSH キーペアを使用すると、パスワードなしで Linux インスタンスにログインできます。

以下のパラメーターで CreateKeyPair を呼び出します。

ステップ 5：ECS インスタンスの作成

以下のパラメーターで RunInstances を呼び出します。

RunInstances を呼び出した後、インスタンスのステータスが 実行中 になるまで DescribeInstanceStatus をポーリングします。通常、約 10 秒かかります。

従量課金インスタンスを作成する前に、アカウントに十分な残高があることを確認してください。

完全なサンプルコード

以下のコードは、すべての前提リソースを順に作成し、その後 ECS インスタンスを作成して起動を待ちます。

import com.aliyun.ecs20140526.models.*;
import com.aliyun.teaopenapi.models.Config;
import com.aliyun.vpc20160428.models.CreateVSwitchRequest;
import com.aliyun.vpc20160428.models.CreateVSwitchResponse;
import com.aliyun.vpc20160428.models.CreateVpcRequest;
import com.aliyun.vpc20160428.models.CreateVpcResponse;
import com.aliyun.vpc20160428.models.DescribeVpcsRequest;

import java.util.ArrayList;
import java.util.List;

public class EcsDemo {
    public static void main(String[] args) {
        String vpcId = null;
        String vSwitchId = null;
        String securityGroupId = null;
        String instanceId = null;
        com.aliyun.vpc20160428.Client vpcClient = null;
        com.aliyun.ecs20140526.Client ecsClient = null;
        try {
            vpcClient = createVpcClient();
            ecsClient = createEcsClient();
            // VPC を作成します。
            vpcId = createVpc(vpcClient);
            System.out.println("VPC create success, vpcId :" + vpcId);
            // 次に進む前に、VPC が Available 状態になるまで待機します。
            while (true) {
                String status = describeVpc(vpcId, vpcClient);
                if ("Available".equals(status)) {
                    break;
                }
            }
            // vSwitch を作成します。
            vSwitchId = CreateVSwitch(vpcId, vpcClient);
            System.out.println("VSwitch create success, vSwitchId :" + vSwitchId);
            // セキュリティグループを作成します。
            securityGroupId = createSecurityGroup(vpcId, ecsClient);
            System.out.println("SecurityGroup create success, securityGroupId :" + securityGroupId);
            // セキュリティグループにインバウンドルールを追加します。
            authorizeSecurityGroup(securityGroupId, ecsClient);
            // SSH キーペアを作成します。インスタンスへのログイン時に後で使用するために秘密鍵を保存します。
            CreateKeyPairResponse keyPair = createKeyPair(ecsClient);
            System.out.println("KeyPair create success, keyPairName :" + keyPair.body.keyPairName);
            // ECS インスタンスを作成します。
            instanceId = createInstance(ecsClient, vSwitchId, securityGroupId);
            System.out.println("ECS create success, instanceId :" + instanceId);
            // インスタンスが Running 状態になるまで待機します。
            while (true) {
                List<String> instanceIds = new ArrayList<>();
                instanceIds.add(instanceId);
                DescribeInstanceStatusResponse describeInstanceStatus = describeInstanceStatus(instanceIds, ecsClient);
                List<DescribeInstanceStatusResponseBody.DescribeInstanceStatusResponseBodyInstanceStatusesInstanceStatus> instanceStatusList = describeInstanceStatus.body.instanceStatuses.instanceStatus;
                if (instanceStatusList != null && !instanceStatusList.isEmpty()) {
                    String status = instanceStatusList.get(0).status;
                    if ("Running".equals(status)) {
                        break;
                    }
                }
            }
        } catch (Exception e) {
            // 失敗前に一部のリソースが作成された場合は、ログ記録、ロールバック、
            // または補償ロジックを追加して、部分的な状態をクリーンアップします。
            System.out.println(e.getMessage());
        }
    }

    public static class Constants {
        public static final String NAME = "sdk-test";
        public static final String REGION_ID = "cn-hangzhou";
        public static final String ZONE_ID = "cn-hangzhou-i";
        public static final String CIDR_BLOCK_VPC = "192.168.0.0/16";
        public static final String CIDR_BLOCK_VSWITCH = "192.168.0.0/24";
        public static final String IMAGE_ID = "aliyun_3_x64_20G_scc_alibase_20220225.vhd";
        public static final String INSTANCE_TYPE = "ecs.e-c1m2.xlarge";
        public static final String SYSTEM_DISK_CATEGORY = "cloud_essd";
        public static final String KEY_PAIR_NAME = "sdk-key-pair";

        public static final class ENDPOINT {
            public static final String VPC = "vpc.cn-hangzhou.aliyuncs.com";
            public static final String ECS = "ecs.cn-hangzhou.aliyuncs.com";
        }

        public static final class INSTANCE_CHARGE_TYPE {
            public static final String PRE_PAID = "PrePaid";   // サブスクリプション
            public static final String POST_PAID = "PostPaid"; // 従量課金
        }
    }

    public static com.aliyun.vpc20160428.Client createVpcClient() throws Exception {
        Config config = new Config();
        config.setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"));
        config.setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
        config.endpoint = Constants.ENDPOINT.VPC;
        return new com.aliyun.vpc20160428.Client(config);
    }

    public static com.aliyun.ecs20140526.Client createEcsClient() throws Exception {
        Config config = new Config();
        config.setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"));
        config.setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
        config.endpoint = Constants.ENDPOINT.ECS;
        return new com.aliyun.ecs20140526.Client(config);
    }

    /**
     * VPC を作成し、その ID を返します。
     *
     * @param vpcClient VPC クライアント。
     * @return 新しい VPC の ID。
     */
    public static String createVpc(com.aliyun.vpc20160428.Client vpcClient) {
        try {
            CreateVpcRequest createVpcRequest = new CreateVpcRequest()
                    .setRegionId(Constants.REGION_ID)
                    .setCidrBlock(Constants.CIDR_BLOCK_VPC)
                    .setVpcName(Constants.NAME);
            CreateVpcResponse vpc = vpcClient.createVpc(createVpcRequest);
            return vpc.body.vpcId;
        } catch (Exception e) {
            throw new RuntimeException("createVpc failed: " + e.getMessage());
        }
    }

    /**
     * 指定された VPC に vSwitch を作成し、その ID を返します。
     *
     * @param vpcId     VPC の ID。
     * @param vpcClient VPC クライアント。
     * @return 新しい vSwitch の ID。
     */
    public static String CreateVSwitch(String vpcId, com.aliyun.vpc20160428.Client vpcClient) {
        try {
            CreateVSwitchRequest createVSwitchRequest = new CreateVSwitchRequest()
                    .setRegionId(Constants.REGION_ID)
                    .setZoneId(Constants.ZONE_ID)
                    .setCidrBlock(Constants.CIDR_BLOCK_VSWITCH)
                    .setVpcId(vpcId)
                    .setVSwitchName(Constants.NAME);
            CreateVSwitchResponse vSwitch = vpcClient.createVSwitch(createVSwitchRequest);
            return vSwitch.body.vSwitchId;
        } catch (Exception e) {
            throw new RuntimeException("CreateVSwitch failed: " + e.getMessage());
        }
    }

    /**
     * 指定された VPC にセキュリティグループを作成し、その ID を返します。
     *
     * @param vpcId     VPC の ID。
     * @param ecsClient ECS クライアント。
     * @return 新しいセキュリティグループの ID。
     */
    public static String createSecurityGroup(String vpcId, com.aliyun.ecs20140526.Client ecsClient) {
        try {
            CreateSecurityGroupRequest createSecurityGroupRequest = new CreateSecurityGroupRequest()
                    .setRegionId(Constants.REGION_ID)
                    .setVpcId(vpcId)
                    .setSecurityGroupName(Constants.NAME);
            CreateSecurityGroupResponse securityGroup = ecsClient.createSecurityGroup(createSecurityGroupRequest);
            return securityGroup.body.securityGroupId;
        } catch (Exception e) {
            throw new RuntimeException("createSecurityGroup failed: " + e.getMessage());
        }
    }

    /**
     * 指定されたセキュリティグループに、すべてのソースからのポート 22 (SSH) でのインバウンド TCP ルールを追加します。
     *
     * @param securityGroupId セキュリティグループの ID。
     * @param ecsClient       ECS クライアント。
     */
    public static void authorizeSecurityGroup(String securityGroupId, com.aliyun.ecs20140526.Client ecsClient) {
        try {
            AuthorizeSecurityGroupRequest.AuthorizeSecurityGroupRequestPermissions permission =
                    new AuthorizeSecurityGroupRequest.AuthorizeSecurityGroupRequestPermissions()
                            .setIpProtocol("tcp")
                            .setPortRange("22/22")
                            .setSourceCidrIp("0.0.0.0/0");
            List<AuthorizeSecurityGroupRequest.AuthorizeSecurityGroupRequestPermissions> permissions = new ArrayList<>();
            permissions.add(permission);
            AuthorizeSecurityGroupRequest authorizeSecurityGroupRequest = new AuthorizeSecurityGroupRequest()
                    .setRegionId(Constants.REGION_ID)
                    .setSecurityGroupId(securityGroupId)
                    .setPermissions(permissions);
            ecsClient.authorizeSecurityGroup(authorizeSecurityGroupRequest);
        } catch (Exception e) {
            throw new RuntimeException("authorizeSecurityGroup failed: " + e.getMessage());
        }
    }

    /**
     * ECS インスタンスを作成し、その ID を返します。
     *
     * @param ecsClient       ECS クライアント。
     * @param vSwitchId       vSwitch の ID。
     * @param securityGroupId セキュリティグループの ID。
     * @return 新しい ECS インスタンスの ID。
     */
    public static String createInstance(com.aliyun.ecs20140526.Client ecsClient, String vSwitchId, String securityGroupId) {
        try {
            RunInstancesRequest.RunInstancesRequestSystemDisk systemDisk =
                    new RunInstancesRequest.RunInstancesRequestSystemDisk()
                            .setCategory(Constants.SYSTEM_DISK_CATEGORY);
            RunInstancesRequest runInstancesRequest = new RunInstancesRequest()
                    .setRegionId(Constants.REGION_ID)
                    .setImageId(Constants.IMAGE_ID)
                    .setInstanceType(Constants.INSTANCE_TYPE)
                    .setSecurityGroupId(securityGroupId)
                    .setVSwitchId(vSwitchId)
                    .setInstanceChargeType(Constants.INSTANCE_CHARGE_TYPE.POST_PAID)
                    .setInstanceName(Constants.NAME)
                    .setInternetMaxBandwidthOut(1)
                    .setSystemDisk(systemDisk)
                    .setKeyPairName(Constants.KEY_PAIR_NAME);
            RunInstancesResponse resp = ecsClient.runInstances(runInstancesRequest);
            return resp.body.getInstanceIdSets().getInstanceIdSet().get(0);
        } catch (Exception e) {
            throw new RuntimeException("createInstance failed: " + e.getMessage());
        }
    }

    /**
     * SSH キーペアを作成し、完全なレスポンス (秘密鍵を含む) を返します。
     *
     * @param ecsClient ECS クライアント。
     * @return CreateKeyPair からのレスポンス。キーペア名と秘密鍵のマテリアルを含みます。
     */
    public static CreateKeyPairResponse createKeyPair(com.aliyun.ecs20140526.Client ecsClient) {
        try {
            CreateKeyPairRequest createKeyPairRequest = new CreateKeyPairRequest()
                    .setRegionId(Constants.REGION_ID)
                    .setKeyPairName(Constants.KEY_PAIR_NAME);
            return ecsClient.createKeyPair(createKeyPairRequest);
        } catch (Exception e) {
            throw new RuntimeException("createKeyPair failed: " + e.getMessage());
        }
    }

    /**
     * 指定された VPC の現在のステータスを返します。
     *
     * @param vpcId     VPC ID。
     * @param vpcClient VPC クライアント。
     * @return VPC のステータス文字列 (例: "Available")。
     */
    public static String describeVpc(String vpcId, com.aliyun.vpc20160428.Client vpcClient) {
        try {
            DescribeVpcsRequest request = new DescribeVpcsRequest()
                    .setRegionId(Constants.REGION_ID)
                    .setVpcId(vpcId);
            return vpcClient.describeVpcs(request).body.vpcs.getVpc().get(0).status;
        } catch (Exception e) {
            throw new RuntimeException("describeVpc failed: " + e.getMessage());
        }
    }

    /**
     * 指定された ECS インスタンスのステータスを返します。
     *
     * @param instanceIds クエリ対象の ECS インスタンス ID のリスト。
     * @param ecsClient   ECS クライアント。
     * @return DescribeInstanceStatus レスポンス。
     */
    public static DescribeInstanceStatusResponse describeInstanceStatus(List<String> instanceIds, com.aliyun.ecs20140526.Client ecsClient) {
        try {
            DescribeInstanceStatusRequest request = new DescribeInstanceStatusRequest()
                    .setRegionId(Constants.REGION_ID)
                    .setInstanceId(instanceIds);
            return ecsClient.describeInstanceStatus(request);
        } catch (Exception e) {
            throw new RuntimeException("describeInstanceStatus failed: " + e.getMessage());
        }
    }
}