Alibaba Cloud SDK:Alibaba Cloud SDK V1.0 for Java と統合する

クラウドサービス SDK

クラウドサービスの SDK には、API 操作の呼び出しに必要なリクエストオブジェクトとレスポンスオブジェクトが含まれています。この例では、Elastic Compute Service (ECS) SDK V1.0 for Java が Maven の依存関係として設定されています。次のサンプルコードは、Maven の依存関係を示しています。

<dependencies>
  <!--  ecs V1.0 SDK  -->
  <dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>aliyun-java-sdk-ecs</artifactId>
    <version>5.11.7</version>
  </dependency>
</dependencies>

Alibaba Cloud サービスの Java 用 SDK V1.0 は、aliyun-java-sdk-${Service code} の形式で命名されています。特定の Alibaba Cloud サービスの Java 用 SDK V1.0 に関する情報は、SDK センター でも確認できます。

SDK のコアライブラリ

SDK のコアライブラリには、クライアントオブジェクト、署名ロジック、およびエラー処理ロジックが含まれており、これらは API 操作の呼び出しに必要な情報です。SDK のコアライブラリを Maven の依存関係として設定することをお勧めします。次のサンプルコードは、Maven の依存関係を示しています。

<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>aliyun-java-sdk-core</artifactId>
    <version>4.7.3</version>
</dependency>

コアライブラリのバージョンの詳細については、「Maven Repository: com.aliyun » aliyun-java-sdk-core」をご参照ください。

1. リクエストクライアントを初期化する

すべての API 操作は、コアライブラリによって提供される Client オブジェクトを使用して呼び出されます。API 操作を呼び出す前に、リクエストクライアントを初期化する必要があります。この例では、リクエストクライアントは AccessKey ペアを使用して初期化されます。詳細については、「アクセス認証情報を管理する」をご参照ください。

com.aliyuncs.profile.DefaultProfile profile = com.aliyuncs.profile.DefaultProfile.getProfile(
        "<REGION_ID>",
        // RAM ユーザーの AccessKey ID を環境変数から取得します。
        System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"),
        // RAM ユーザーの AccessKey シークレットを環境変数から取得します。
        System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
com.aliyuncs.IAcsClient client = new com.aliyuncs.DefaultAcsClient(profile);

2. リクエストオブジェクトを作成する

SDK によって提供されるリクエストオブジェクトを使用して、リクエストパラメータをカプセル化できます。

com.aliyuncs.ecs.model.v20140526.DescribeInstancesRequest request = new com.aliyuncs.ecs.model.v20140526.DescribeInstancesRequest();
request.setRegionId("cn-hangzhou");
request.setInstanceIds(new com.google.gson.Gson().toJson(Arrays.asList("i-bp1fq61ktxxxxxxxxxxxx","i-bp1fq62ktxxxxxxxxxxxx")));

3. API リクエストを開始する

手順 1 で構築したリクエストクライアントを使用して、getAcsResponse 操作を呼び出します。操作のリクエストパラメータは、手順 2 で作成したリクエストオブジェクトです。呼び出しが成功すると、レスポンスオブジェクトが返されます。

com.aliyuncs.ecs.model.v20140526.DescribeInstancesResponse response = client.getAcsResponse(request);
System.out.println(new com.google.gson.Gson().toJson(response));

4. エラーを処理する

API 操作の呼び出し時にエラーがトリガーされた場合は、ServerException および ClientException をキャプチャしてエラーメッセージを取得できます。ほとんどの場合、ClientException エラーは、無効な AccessKey パラメータなど、クライアントの初期化中の無効なパラメータが原因で発生します。ServerException エラーは、いくつかの要因によって発生する可能性があります。トラブルシューティングについてはカスタマーサービスにリクエストし、リクエスト ID を提供してください。