通過云控制API實現(xiàn)資源管理
本文以專有網(wǎng)絡(luò)資源為例,演示如何通過OpenAPI門戶調(diào)用云控制API的方式,管理專有網(wǎng)絡(luò)VPC資源的全生命周期。
前提條件
您需要登錄OpenAPI門戶,建議使用RAM用戶,RAM用戶需要以下權(quán)限:
1.管理云控制API的權(quán)限,請參見為RAM用戶授權(quán)。
2.管理專有網(wǎng)絡(luò)VPC服務(wù)的權(quán)限,請參見使用RAM對VPC進行權(quán)限管理。
操作步驟
在線調(diào)用云控制API,實現(xiàn)專有網(wǎng)絡(luò)VPC的創(chuàng)建、獲取、更新、列舉和刪除操作。若需集成云控制API,請參考在線調(diào)試API門戶生成的示例代碼。
1.創(chuàng)建專有網(wǎng)絡(luò)資源
使用RAM用戶登錄OpenAPI門戶,進入專有網(wǎng)絡(luò)資源創(chuàng)建界面后,選擇regionId,填寫body資源屬性的參數(shù)值,點擊發(fā)起調(diào)用。右側(cè)示例代碼您可選擇語言,系統(tǒng)會自動生成代碼以供您參考。
發(fā)起調(diào)用后,查看調(diào)用結(jié)果。
若調(diào)用報錯,請參考去診斷中的日志信息、API文檔或公共錯誤碼進行問題分析和解決,也可聯(lián)系我們。
若調(diào)用成功,記錄返回信息中的資源ID(resourceId),狀態(tài)碼是200表示為同步操作,即資源創(chuàng)建任務(wù)完成;狀態(tài)碼是202表示為異步操作,需要根據(jù)返回的taskId進一步查詢?nèi)蝿?wù)的狀態(tài)。
說明同步操作與異步操作是程序處理任務(wù)執(zhí)行的兩種模式,區(qū)別在于,同步操作在任務(wù)執(zhí)行完成后才返回,而異步操作則不等待任務(wù)執(zhí)行完成就返回。
示例中調(diào)用結(jié)果返回的狀態(tài)碼是202,為異步操作,您需要通過taskId查詢?nèi)蝿?wù)狀態(tài)。記錄taskId,點擊查詢?nèi)蝿?wù),跳轉(zhuǎn)到查詢?nèi)蝿?wù)界面。
輸入taskId,點擊發(fā)起調(diào)用。查看調(diào)用結(jié)果,調(diào)用成功,任務(wù)status為Succeeded,VPC資源創(chuàng)建完成。
在阿里云控制臺中查看創(chuàng)建的VPC。
2.獲取專有網(wǎng)絡(luò)資源
進入專有網(wǎng)絡(luò)資源獲取界面后,輸入資源ID,選擇regionId,點擊發(fā)起調(diào)用。查看調(diào)用結(jié)果,顯示調(diào)用成功并返回了資源信息。
3.更新專有網(wǎng)絡(luò)資源
進入專有網(wǎng)絡(luò)資源更新界面后,輸入資源ID,選擇regionId,輸入需要更新的參數(shù)值,點擊發(fā)起調(diào)用。查看調(diào)用結(jié)果,驗證更新結(jié)果可通過阿里云控制臺或云控制API查看資源信息。
4.列舉專有網(wǎng)絡(luò)資源
進入專有網(wǎng)絡(luò)資源列舉界面后,選擇regionId,點擊發(fā)起調(diào)用。查看調(diào)用結(jié)果,可以看到資源信息。
5.刪除專有網(wǎng)絡(luò)資源
進入專有網(wǎng)絡(luò)資源刪除界面后,輸入資源ID,選擇regionId,點擊發(fā)起調(diào)用,查看調(diào)用結(jié)果。
顯示調(diào)用成功,返回碼202,說明本次調(diào)用為異步操作。
進入查詢?nèi)蝿?wù)界面后,輸入taskId,點擊發(fā)起調(diào)用。查看調(diào)用結(jié)果,任務(wù)status為Succeeded,即VPC資源已刪除完成。
示例代碼
代碼地址:https://github.com/aliyun/cloud-control-api-demo
這個倉庫提供了云控制api的代碼示例,它將幫助您查詢資源元數(shù)據(jù)和管理云資源。