本文介紹如何在阿里雲OpenAPI開發人員門戶調用API擷取並使用Java SDK範例程式碼。
前提條件
已下載並安裝JDK 1.8或更高版本,並已經配置Java環境變數。
已下載並安裝Java開發工具。
本文以IntelliJ IDEA為例。
已擷取存取金鑰AccessKey。
在調用阿里雲API時您需要使用AccessKey完成身分識別驗證。AccessKey包括AccessKey ID和AccessKey Secret。關於如何建立和擷取AccessKey,請參見建立AccessKey。
操作步驟
步驟一:下載SDK完整工程
進入OpenAPI門戶的API調試頁面,在左側選擇API介面。
本樣本以DescribeSourceServers介面為例。
在左側的參數配置頁簽,選擇服務地址,並填寫需要的參數資訊。填寫時請參考右側的文檔頁簽,充分瞭解介面的說明和注意事項(尤其是費用相關資訊),以及各參數的具體含義和使用方法。
在右側的SDK樣本頁簽,選擇Java語言,單擊下載完整工程按鈕,下載SDK完整工程至本地並解壓。
說明如果您需要複製SDK範例程式碼,具體操作,請參見如何自動產生SDK樣本。
關於Java SDK範例程式碼的詳細說明,請參見SDK快速入門。
步驟二:匯入解壓後的工程
開啟開發人員工具IDEA。
在頂部菜單中,選擇
。在彈出的對話方塊中,選擇解壓後的SDK完整工程檔案。
步驟三:配置身分識別驗證
通過阿里雲提供的Credentials工具,配置提供者時的身分識別驗證。阿里雲SDK支援通過定義ALIBABA_CLOUD_ACCESS_KEY_ID
和ALIBABA_CLOUD_ACCESS_KEY_SECRET
環境變數來建立預設的訪問憑證。調用介面時,程式直接存取憑證,讀取您的存取金鑰(即AccessKey)並自動完成鑒權。
阿里雲Credentials工具提供多種身分識別驗證配置方案,更多資訊,請參見身分識別驗證配置。
在
pom.xml
檔案中,添加以下依賴,安裝阿里雲SDK Credentials工具。說明阿里雲SDK Credentials工具的版本會持續更新,建議您可以訪問版本更新日誌擷取最新版本。
<dependency> <groupId>com.aliyun</groupId> <artifactId>credentials-java</artifactId> <version>0.2.11</version> </dependency>
按右鍵pom.xml檔案,選擇Maven > Reload project,Maven專案管理工具會自動下載相關的jar包。
配置環境變數
ALIBABA_CLOUD_ACCESS_KEY_ID
和ALIBABA_CLOUD_ACCESS_KEY_SECRET
。具體操作,請參見在Linux、macOS和Windows系統配置環境變數。說明建立和擷取AccessKey的具體操作,請參見建立AccessKey。
步驟四:運行SDK範例程式碼
在IDEA左側導覽列中,開啟Java SDK範例程式碼檔案。
在頂部菜單中,選擇
運行代碼。查看代碼運行結果。
後續您可以根據需要對SDK配置HTTPS請求、代理、逾時和重試機制等,具體操作,請參見進階配置。