Java SDK調(diào)用示例
使用OpenAPI自動化集成云備份,可以提升您使用云備份的開發(fā)效率。本文介紹如何使用OpenAPI調(diào)用云備份DescribeBackupPlans接口查詢ECS文件備份計劃。
步驟一:查看OpenAPI文檔
在調(diào)用OpenAPI前,建議您先閱讀對應(yīng)接口文檔,了解、學(xué)習(xí)調(diào)用該接口所需要的參數(shù)及權(quán)限等。更多信息,請參見API概覽。
步驟二:創(chuàng)建RAM用戶并完成授權(quán)
阿里云賬號擁有所有API的訪問權(quán)限,建議您創(chuàng)建并使用RAM用戶進(jìn)行API訪問或日常運維。
本步驟主要用于創(chuàng)建一個具有只讀云備份資源權(quán)限的RAM用戶。
如果您已創(chuàng)建RAM用戶且已完成授權(quán),可跳過此步驟。
使用阿里云賬號登錄RAM控制臺。
創(chuàng)建RAM用戶。
在左側(cè)導(dǎo)航欄,選擇
。在用戶頁面,單擊創(chuàng)建用戶。
在創(chuàng)建用戶頁面,設(shè)置登錄名稱和顯示名稱均為config-openapi-operator-hbr,設(shè)置訪問方式為控制臺訪問和OpenAPI調(diào)用訪問 ,單擊確定。
重要RAM用戶的AccessKey Secret只在創(chuàng)建時顯示,不支持查看,請下載CSV文件后妥善保管。
創(chuàng)建RAM用戶成功后,請記錄用戶登錄名稱和密碼,您在調(diào)用OpenAPI時,需要使用該RAM用戶登錄阿里云OpenAPI開發(fā)者門戶,并使用該RAM用戶的AccessKey進(jìn)行代碼調(diào)試。
為RAM用戶授權(quán)。
說明創(chuàng)建RAM用戶后,該RAM用戶無任何操作云備份的權(quán)限。您需要為該RAM用戶授予系統(tǒng)策略(AliyunHBRFullAccess、AliyunHBRReadOnlyAccess)或自定義策略。本案例以授予RAM用戶AliyunHBRReadOnlyAccess策略為例,AliyunHBRReadOnlyAccess策略具備云備份資源的只讀權(quán)限。
在用戶頁面,單擊目標(biāo)RAM用戶(config-openapi-operator-hbr)對應(yīng)的添加權(quán)限。
在新增授權(quán)面板,在系統(tǒng)策略中搜索選中AliyunHBRReadOnlyAccess,然后單擊確認(rèn)新增授權(quán)。
確認(rèn)授權(quán)結(jié)果,單擊關(guān)閉。
(可選)步驟三:在線調(diào)試OpenAPI
使用RAM用戶登錄阿里云OpenAPI門戶。
選擇云產(chǎn)品為云備份服務(wù)。
在頂部菜單欄,選擇工具中心>在線調(diào)試。
在左側(cè)導(dǎo)航欄,找到并單擊DescribeBackupPlans接口,服務(wù)地址選擇華東1(杭州),SourceType參數(shù)輸入ECS_FILE,表示查詢ECS類型的備份計劃。
單擊發(fā)起調(diào)用。
在調(diào)用結(jié)果區(qū)域,您可以看到查詢結(jié)果、Request Header、Response Header等信息,狀態(tài)碼200表示調(diào)用成功。
步驟四:獲取SDK示例代碼
OpenAPI平臺提供了多種編程語言(Java、Go、Python、Node.js、TypeScript、PHP、C++ 等)的SDK。開發(fā)者只需要集成SDK,通過SDK暴露的方法直接調(diào)用OpenAPI 。SDK統(tǒng)一封裝了簽名邏輯、超時機制、重試機制,并根據(jù)文檔返回結(jié)構(gòu)化 Response 對象,易于開發(fā)。
以獲取Java SDK示例代碼為例,其他語言獲取方式相同。
在SDK示例頁簽,選擇SDK版本和SDK語言。推薦使用V2.0版本。關(guān)于V2.0和V1.0的區(qū)別,請參見V1.0 SDK和V2.0 SDK區(qū)別。
單擊下載完整工程可以下載完整的SDK工程。下載完后完成解壓。
說明在SDK示例顯示區(qū)域的右上角,單擊圖標(biāo)可以復(fù)制SDK示例代碼。
單擊SDK信息,可以獲取SDK包名稱、SDK包版本、SDK包管理平臺、SDK安裝命令等基礎(chǔ)信息,便于您集成開發(fā)。
步驟五:運行SDK示例代碼
以運行Java SDK示例代碼為例。
打開IntelliJ IDEA,單擊File->Open,選擇解壓后的工程文件夾,等待Maven自動安裝依賴信息。
在調(diào)用之前,需要先獲取訪問憑證AccessKey,建議使用前面創(chuàng)建的RAM用戶AccessKey。更多信息,請參見創(chuàng)建RAM用戶的AccessKey。
重要獲取RAM用戶的AccessKey之后,還需要在環(huán)境變量中設(shè)置AccessKey,具體操作步驟請參見在Linux、macOS和Windows系統(tǒng)配置環(huán)境變量。
運行示例代碼。
雙擊打開Sample,確認(rèn)無報錯后,運行代碼。
查看運行結(jié)果。在底部控制臺按下
ctrl+f
,搜索statusCode
,如果看到"statusCode":200
表示調(diào)用成功。
報錯處理
code: 404, Specified access key is not found.
您在環(huán)境變量中配置的AccessKey沒有生效,建議重啟IDE或者系統(tǒng)后重試。
code: 403, User is not authorized to do this operation.
您使用的RAM用戶沒有足夠的權(quán)限,無法執(zhí)行該操作。例如,您授予RAM用戶AliyunHBRReadOnlyAccess權(quán)限,使用該RAM用戶只能查詢接口,調(diào)用CreateVault等接口時,服務(wù)端會返回code: 403, User is not authorized to do this operation.。
您需要使用阿里云賬號登錄RAM控制臺,在RAM訪問控制臺,為RAM用戶增加該操作的權(quán)限,然后進(jìn)行操作。更多授權(quán)操作,請參見使用RAM進(jìn)行訪問控制。