新しいバージョンの SDK ファイル名は、通常、"aliyun-XXXX-sdk" で始まり、次に製品名が続きます。たとえば "aliyun-java-sdk-ecs" のようなパッケージ名です。 "aliyun-java-sdk-core" コアパッケージは、"IClientProfile"、"IAcsClient"、および例外クラスなど、すべての SDK 製品で使用されている特定のクラスをカプセル化します。 クラスは製品ごとに異なる JAR パッケージに格納されています。
「 AccessKey 」の作成ができる状態にします。
Java SDK を使用した例
この例では、API メソッドDescribeImagesは使用可能なイメージリソースを照会するために使用されます。 API メソッドを Java SDK を使用するプロセスの例として説明します。 "aliyun-java-sdk-core" パッケージには、"IClientProfile" クラスと "IAcsClient" クラスが含まれ、 "aliyun-java-sdk-ecs" パッケージにはそれ以外のクラスが含まれています。
- プロファイルオブジェクトの作成: "profile" という名前の "IClientProfile" クラスのインスタンスを作成します。このインスタンスには、"AccessKeyID"、"AccessKeySecret"、および
"cn-hangzhou" などのデフォルトのリージョン情報が含まれています。 Alibaba Cloud のリージョン詳細については、「リージョンとゾーン」をご参照ください。
IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou", ak, aks); #ak is your AccessKey, and aks is your AccessKeySecret.
- クライアントオブジェクトの作成: 上記で作成した "IClientProfile" プロファイルから "client" という名前の "IAcsClient" オブジェクトを作成し、その後のレスポンスは
"IClientProfile" から取得します。 このオブジェクトには、後で取得するレスポンスデータが含まれています。
IAcsClient client = new DefaultAcsClient(profile);
- Request クラスの作成: メソッドに対応するリクエストクラスを作成し、API メソッド名の最後に "Request" を追加してクラスに名前を付けます。 たとえば、イメージリストを照会する API メソッドの名前がDescribeImagesである場合、対応するリクエストクラス名は "DescribeImagesRequest" です。 コンストラクターを使用して、デフォルトの "Describe" クラスを生成します。
DescribeImagesRequest describe = new DescribeImagesRequest();
- リクエストパラメーターの指定: セッター "setXxx" を使用して必要な API パラメーターを指定します。 たとえば、DescribeImagesAPI メソッドは、"IClientProfile" に既にリージョン情報が含まれているため、オプションである "RegionId" パラメーターを必要とします。 他のパラメーターを設定するには、他の "setters" を使用します。 たとえば、カスタムイメージを照会するには、 "ImageOwnerAlias" を "self" に設定します。
describe.setImageOwnerAlias("self");
- "IAcsClient" オブジェクトを使用してリクエストに対するレスポンスを取得します。
DescribeImagesResponse response = client.getAcsResponse(describe);
- レスポンスからのレスポンスパラメーター取得: レスポンスでゲッター "getXxx" を呼び出し、戻り値 "ImageName" などを取得します。 API メソッドごとに、戻り値に構造化情報が含まれることがあります。 たとえば、"DescribeImages"
のメソッドでは、戻り値には Java SDK のイメージコレクションが含まれます。 "getImages()" メソッドを呼び出してイメージオブジェクトリストを照会し、リストを繰り返してイメージを照会します。次に、"getXxx" を呼び出し、さらに情報を取得します。
for(Image image:response.getImages()) { System.out.println(image.getImageId()); System.out.println(image.getImageName()); }
これで呼び出し処理の完了です。
PHP SDK に関する注意事項
PHP SDK のを使用方法は、Java SDK と同じ方法です。 以下の手順に従います。
- プロファイルオブジェクトを作成します。
- クライアントオブジェクトを作成します。
- リクエストオブジェクトを作成します。
- リクエストパラメーターを設定します。
- リクエストオブジェクトを渡して戻り値を取得することにより、クライアントオブジェクトに対応する API メソッドを呼び出します。
- レスポンスの戻り値を取得します。
Python SDK に関する注意事項
Python SDK を使用する場合、プロファイルを作成する必要はありません。 代わりにクライアントを直接作成し、残りの手順を続行します。
参考文献
-
ECS での利用可能な API メソッドの詳細については、API Overviewをご参照ください。
-
"AccessKey" を作成する方法の詳細については、「 AccessKey の作成」をご参照ください。