Enterprise Distributed Application Service:EDAS Java SDK を使用した ECS アプリケーションのインスタンスグループ管理

クイックスタート

次の例では、Beta という名前のインスタンスグループを作成し、それをアプリケーションバージョンに関連付け、結果として得られるグループ ID を出力します。プレースホルダー ID はご自身の値に置き換えてください。

import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.edas.model.v20170801.InsertDeployGroupRequest;
import com.aliyuncs.edas.model.v20170801.InsertDeployGroupResponse;

public class QuickStart {
    public static void main(String[] args) throws Exception {
        String regionId = "cn-hangzhou";
        String accessKeyId = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
        String accessKeySecret = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");

        DefaultProfile profile = DefaultProfile.getProfile(regionId, accessKeyId, accessKeySecret);
        DefaultAcsClient client = new DefaultAcsClient(profile);

        InsertDeployGroupRequest request = new InsertDeployGroupRequest();
        request.setAppId("6bbc57a2-a017-4bec-b521-49a15bd3****");
        request.setGroupName("Beta");
        request.setInitPackageVersionId("3fc52328-8746-4422-a742-94e0cfc7****");

        InsertDeployGroupResponse response = client.getAcsResponse(request);
        System.out.println("GroupName=" + response.getDeployGroupEntity().getGroupName()
            + "\nId=" + response.getDeployGroupEntity().getId());
    }
}

期待される出力：

GroupName=Beta
Id=941be68c-4aac-48a1-88fe-c9ad1502****

インスタンスのグループ間移動、JVM および Tomcat の設定、グループの削除などの詳細な操作については、以降のセクションをご参照ください。

共通のクライアント設定

このトピックのすべての例は、同じクライアント初期化を共有します。いずれかの操作を実行する前に、一度だけ設定してください。

import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.profile.DefaultProfile;

// アプリケーションが実行されているリージョン ID に置き換えます
String regionId = "cn-hangzhou";

// 環境変数から AccessKey 認証情報を取得します
String accessKeyId = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
String accessKeySecret = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");

DefaultProfile profile = DefaultProfile.getProfile(regionId, accessKeyId, accessKeySecret);
DefaultAcsClient client = new DefaultAcsClient(profile);

コードを実行する前に、次の環境変数を設定してください。

インスタンスグループの作成

InsertDeployGroup を呼び出してインスタンスグループを作成し、アプリケーションバージョンに関連付けます。

パラメーター

サンプルコード

import com.aliyuncs.edas.model.v20170801.InsertDeployGroupRequest;
import com.aliyuncs.edas.model.v20170801.InsertDeployGroupResponse;

InsertDeployGroupRequest request = new InsertDeployGroupRequest();
request.setAppId("6bbc57a2-a017-4bec-b521-49a15bd3****");
request.setGroupName("Beta");
request.setInitPackageVersionId("3fc52328-8746-4422-a742-94e0cfc7****");

try {
    InsertDeployGroupResponse response = client.getAcsResponse(request);
    System.out.println("GroupName=" + response.getDeployGroupEntity().getGroupName()
        + "\nId=" + response.getDeployGroupEntity().getId());
} catch (com.aliyuncs.exceptions.ClientException e) {
    // 一般的なエラー：
    // - Invalid AppId：指定されたアプリケーションが存在しません。
    // - Duplicate GroupName：この名前のグループはすでに存在します。
    e.printStackTrace();
}

サンプルレスポンス

GroupName=Beta
Id=941be68c-4aac-48a1-88fe-c9ad1502****

結果の確認

ListDeployGroup を呼び出し、新しいグループ名がレスポンスに含まれているかどうかを確認します。

{
  "DeployGroupList": {
    "DeployGroup": [
      {
        "GroupName": "Beta",
        "AppId": "6bbc57a2-a017-4bec-b521-49a15bd3****",
        "GroupId": "941be68c-4aac-48a1-88fe-c9ad1502****"
      }
    ]
  },
  "Message": "success",
  "Code": 200
}

ECS インスタンスの別グループへの移動

ChangeDeployGroup を呼び出して、ECS インスタンスをあるインスタンスグループから別のインスタンスグループに移動します。

パラメーター

サンプルコード

import com.aliyuncs.edas.model.v20170801.ChangeDeployGroupRequest;
import com.aliyuncs.edas.model.v20170801.ChangeDeployGroupResponse;

ChangeDeployGroupRequest request = new ChangeDeployGroupRequest();
request.setAppId("6bbc57a2-a017-4bec-b521-49a15bd3****");
request.setEccInfo("4009a824-ce33-4ba0-9ca2-346249a9****");
request.setGroupName("Beta");
request.setForceStatus(true);

try {
    ChangeDeployGroupResponse response = client.getAcsResponse(request);
    System.out.println("Message=" + response.getMessage()
        + "\nChangeOrderId=" + response.getChangeOrderId());
} catch (com.aliyuncs.exceptions.ClientException e) {
    // 一般的なエラー：
    // - Invalid EccInfo：指定された ECC が存在しません。
    // - Version mismatch：移動を強制するには、ForceStatus を true に設定します。
    e.printStackTrace();
}

サンプルレスポンス

Message=success

結果の確認

ListApplicationEcc を呼び出し、ECS インスタンスの GroupId がターゲットグループと一致することを確認します。

{
  "EccInfoList": {
    "EccInfo": [
      {
        "EcuId": "8287bcf6-cde3-4377-8906-086d2c32****",
        "GroupId": "941be68c-4aac-48a1-88fe-c9ad1502****",
        "AppId": "6bbc57a2-a017-4bec-b521-49a15bd3****",
        "EccId": "02cdcdfa-f22b-45e6-8a0f-a738c766****"
      }
    ]
  },
  "Message": "success",
  "Code": 200
}

グループの JVM パラメーター設定

UpdateJvmConfiguration を呼び出して、特定のインスタンスグループの Java 仮想マシン (JVM) パラメーターを設定します。

パラメーター

サンプルコード

import com.aliyuncs.edas.model.v20170801.UpdateJvmConfigurationRequest;
import com.aliyuncs.edas.model.v20170801.UpdateJvmConfigurationResponse;

UpdateJvmConfigurationRequest request = new UpdateJvmConfigurationRequest();
request.setAppId("6bbc57a2-a017-4bec-b521-49a15bd3****");
request.setGroupId("941be68c-4aac-48a1-88fe-c9ad1502****");
request.setMinHeapSize(500);
request.setMaxHeapSize(500);
request.setMaxPermSize(500);
request.setOptions("-Dproperty=value");

try {
    UpdateJvmConfigurationResponse response = client.getAcsResponse(request);
    System.out.println("Message=" + response.getMessage());
} catch (com.aliyuncs.exceptions.ClientException e) {
    // 一般的なエラー：
    // - Invalid GroupId：指定されたインスタンスグループが存在しません。
    e.printStackTrace();
}

サンプルレスポンス

Message=success

結果の確認

GetJvmConfiguration を呼び出して、更新された JVM 設定を確認します。

{
  "Message": "success",
  "JvmConfiguration": {
    "Options": "-Dproperty=value",
    "MaxPermSize": 500,
    "MaxHeapSize": 500,
    "MinHeapSize": 500
  },
  "Code": 200
}

グループの Tomcat パラメーター設定

UpdateContainerConfiguration を呼び出して、特定のインスタンスグループの Tomcat コンテナパラメーターを設定します。

パラメーター

サンプルコード

import com.aliyuncs.edas.model.v20170801.UpdateContainerConfigurationRequest;
import com.aliyuncs.edas.model.v20170801.UpdateContainerConfigurationResponse;

UpdateContainerConfigurationRequest request = new UpdateContainerConfigurationRequest();
request.setAppId("6bbc57a2-a017-4bec-b521-49a15bd3****");
request.setGroupId("941be68c-4aac-48a1-88fe-c9ad1502****");
request.setContextPath("");
request.setHttpPort(8080);
request.setMaxThreads(20);
request.setURIEncoding("ISO-8859-1");
request.setUseBodyEncoding(true);

try {
    UpdateContainerConfigurationResponse response = client.getAcsResponse(request);
    System.out.println("Message=" + response.getMessage());
} catch (com.aliyuncs.exceptions.ClientException e) {
    // 一般的なエラー：
    // - Invalid GroupId：指定されたインスタンスグループが存在しません。
    e.printStackTrace();
}

サンプルレスポンス

Message=success

結果の確認

GetContainerConfiguration を呼び出して、更新された Tomcat 設定を確認します。

{
  "Message": "success",
  "ContainerConfiguration": {
    "HttpPort": 8080,
    "ContextPath": "ROOT",
    "UseBodyEncoding": true,
    "URIEncoding": "ISO-8859-1",
    "MaxThreads": 20
  },
  "Code": 200
}

インスタンスグループの削除

DeleteDeployGroup を呼び出してインスタンスグループを削除します。

パラメーター

サンプルコード

import com.aliyuncs.edas.model.v20170801.DeleteDeployGroupRequest;
import com.aliyuncs.edas.model.v20170801.DeleteDeployGroupResponse;

DeleteDeployGroupRequest request = new DeleteDeployGroupRequest();
request.setAppId("6bbc57a2-a017-4bec-b521-49a15bd3****");
request.setGroupName("Beta");

try {
    DeleteDeployGroupResponse response = client.getAcsResponse(request);
    System.out.println("Message=" + response.getMessage()
        + "\nData=" + response.getData());
} catch (com.aliyuncs.exceptions.ClientException e) {
    // 一般的なエラー：
    // - Group not empty：削除する前に、すべてのインスタンスを別のグループに移動してください。
    // - Invalid GroupName：指定されたグループが存在しません。
    e.printStackTrace();
}

サンプルレスポンス

Message=success
Data=1

結果の確認

ListDeployGroup を呼び出し、削除されたグループがレスポンスに表示されなくなったことを確認します。

{
  "DeployGroupList": {
    "DeployGroup": [
      {
        "GroupName": "_DEFAULT_GROUP",
        "AppId": "6bbc57a2-a017-4bec-b521-49a15bd3****",
        "GroupId": "941be68c-4aac-48a1-88fe-c9ad1502****"
      }
    ]
  },
  "Message": "success",
  "Code": 200
}

エラー処理

すべての EDAS SDK オペレーションは、ClientException (無効なパラメーターやネットワークの問題などのクライアント側エラー) または ServerException (サーバー側エラー) をスローします。次の表に、一般的なエラーシナリオとソリューションを示します。

関連 API