本文示範如何通過OpenAPI門戶調用雲控制API,以Virtual Private Cloud為例,Virtual Private Cloud資源的全生命週期。
前提條件
您需要登入OpenAPI門戶,建議使用RAM使用者,RAM使用者需要以下許可權:
1.管理雲控制API的許可權,請參見RAM使用者管理。
2.管理Virtual Private Cloud服務的許可權,請參見使用RAM對VPC進行許可權管理。
操作步驟
線上調用雲控制API,實現Virtual Private Cloud的建立、擷取、更新、列舉和刪除操作。若需整合雲控制API,請參考線上調試API門戶產生的範例程式碼。
1.建立專用網路資源
使用RAM使用者登入OpenAPI門戶,進入專用網路資源建立介面後,選擇regionId,填寫body資源屬性的參數值,點擊發起調用。右側範例程式碼您可選擇語言,系統會自動產生代碼以供您參考。

發起調用後,查看調用結果。
若調用報錯,請參考去診斷中的日誌資訊、API文檔或公用錯誤碼進行問題分析和解決,也可聯絡我們。
若調用成功,記錄返回資訊中的資源ID(resourceId),狀態代碼是200表示為同步操作,即資源建立任務完成;狀態代碼是202表示為非同步作業,需要根據返回的taskId進一步查詢任務的狀態。
說明同步操作與非同步作業是程式處理任務執行的兩種模式,區別在於,同步操作在任務執行完成後才返回,而非同步作業則不等待任務執行完成就返回。

樣本中調用結果返回的狀態代碼是202,為非同步作業,您需要通過taskId查詢任務狀態。記錄taskId,點擊查詢任務,跳轉到查詢任務介面。

輸入taskId,點擊發起調用。查看調用結果,調用成功,任務status為Succeeded,VPC資源建立完成。

在專用網路管理主控台中查看建立的VPC。

2.擷取專用網路資源
進入專用網路資源擷取介面後,輸入資源ID,選擇regionId,點擊發起調用。查看調用結果,顯示調用成功並返回了資源資訊。

3.更新專用網路資源
進入專用網路資源更新介面後,輸入資源ID,選擇regionId,輸入需要更新的參數值,點擊發起調用。查看調用結果,驗證更新結果可通過專用網路管理主控台或雲控制API查看資源資訊。

4.列舉專用網路資源
進入專用網路資源列舉介面後,選擇regionId,點擊發起調用。查看調用結果,可以看到資源資訊。

5.刪除專用網路資源
進入專用網路資源刪除介面後,輸入資源ID,選擇regionId,點擊發起調用,查看調用結果。

顯示調用成功,返回碼202,說明本次調用為非同步作業。
進入查詢任務介面後,輸入taskId,點擊發起調用。查看調用結果,任務status為Succeeded,即VPC資源已刪除完成。

範例程式碼
代碼地址:https://github.com/aliyun/cloud-control-api-demo
這個倉庫提供了雲控制API的程式碼範例,它將協助您查詢資源中繼資料和管理雲資源。