阿里雲團隊努力不懈,讓最新技術內容能以更快方式以您最熟悉的語言呈現給您。本文內容由機器自動翻譯簡體中文,過程無人工干預。轉碼所造成任何內容錯誤及相關損失,阿里雲概不負責。敬請見諒。若任何內容問題涉及信息準確性,請以英文版為準。
全部產品
Search
文件中心

ECS SDK 使用樣本

更新時間: Aug 23, 2018

新版 SDK 的檔案名通常以 aliyun-XXXX-sdk 開頭,後面跟上產品名稱如 ECS,組成如 aliyun-java-sdk-ecs 的包名。其中有一個核心包 aliyun-java-sdk-core,其中封裝了所有產品的 SDK 都會用到的一些類,如 IClientProfile 類、 IAcsClient 類、異常類等。產品相關的類均以產品為單位打包成不同名稱的 Jar 包。

前提條件

您需要準備好您的 AccessKey,用於輸出到 建立 Profile 中。

Java SDK 使用方法樣本

以 ECS Java SDK 查詢可用鏡像資源的方法 DescribeImages 為例,介紹 SDK 使用的完整流程,其中 IClientProfile 和 IAcsClient 兩個類包含在 aliyun-java-sdk-core 包中,其他的類均包含在 aliyun-java-sdk-ecs 包中。

  1. 建立 Profile。生成 IClientProfile 的對象 profile,該對象存放 AccessKeyID 和 AccessKeySecret 和預設的地域資訊,如樣本中的 cn-hangzhou,更多關於地域的資訊,參閱 地域與可用性區域

    IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou", ak, aks); #ak 是您的 AccessKey,aks 是您的 AccessKeySecret

  2. 建立 Client。從 IClientProfile 類中再生成 IAcsClient 的對象 client,後續獲得 response 都需要從 IClientProfile 中獲得。

    IAcsClient client = new DefaultAcsClient(profile);

  3. 建立 Request。建立一個對應方法的 Request,類的命名規則一般為 API 的方法名加上 “Request”,如獲得鏡像列表的 API 方法名為 DescribeImages,那麼對應的請求類名就是 DescribeImagesRequest,直接使用建構函式生成一個預設的類 describe。

    DescribeImagesRequest describe = new DescribeImagesRequest();

  4. 設定 Request 的參數。請求類生成好之後需要通過 Request 類的 setXxx 方法設定必要的資訊,即 API 參數中必須要提供的資訊,DescribeImages 的 API 方法必須要提供的參數為 RegionId,該值可以省略,因為 IClientProfile 中已經提供了地域資訊,同樣的也可以通過 setXxx 方法設定其他可選的參數,如這裡設定要查詢的鏡像為自訂鏡像,則設定 ImageOwnerAlias 的值為 self,表示查詢您的自訂鏡像。

    describe.setImageOwnerAlias("self");

  5. 參數設定完畢後,通過 IAcsClient 對象獲得對應 Request 的響應。

    DescribeImagesResponse response = client.getAcsResponse(describe);

  6. 在 Response 中獲得返回的參數值。接著可以調用 response 中對應的 getXxx 方法獲得返回的參數值了,如獲得某個鏡像的名字。根據 API 方法的不同,返回的資訊中可能會包含多層的資訊,如獲得鏡像列表這個方法,返回的資訊中鏡像是以一個集合來表示的,集合中存放了每個鏡像的資訊,對於 Java SDK 而言,那麼存放鏡像資訊的就是一個列表,需要先通過 getImages() 獲得 Image 對象的集合,然後再通過遍曆等方法取得其中某個鏡像的資訊,之後調用 getXxx 方法獲得具體的資訊。

    1. for(Image image:response.getImages())
    2. {
    3. System.out.println(image.getImageId());
    4. System.out.println(image.getImageName());
    5. }

至此,一個完整的調用就完成了。

PHP SDK 注意事項

使用 PHP SDK 和 Java SDK 的類似,可以歸納為:

  1. 建立 Profile。
  2. 建立 Client。
  3. 建立 Request。
  4. 設定 Request的參數。
  5. 使用 Client 對應的方法傳入 Request,獲得 Response。
  6. 在 Response 中獲得返回的參數值。

Python SDK 注意事項

使用 Python SDK 省略了建立 Profile 這一步,直接建立 Client,然後執行後面的步驟即可。

參考資訊