全部產品
Search
文件中心

Cloud Control API:基本概念

更新時間:Feb 27, 2025

本文將為您介紹雲控制API涉及到的基本概念。

資源中繼資料

資源中繼資料描述了資源的屬性、類型、關係和行為等資訊,所有的資源管理都是基於資源中繼資料的操作。文章GetResourceType能夠協助您擷取指定資源的中繼資料,解讀返回參數中的中繼資料。

中繼資料資訊可分為三個部分:資源基本資料、資源屬性及擴充資訊。

  • 資源基本資料:主要包括資源名稱、所屬產品、描述、部署層級、付費類型等欄位。

  • 資源屬性:包括資源的具體屬性描述、操作私人參數集合與敏感屬性集合等。

  • 拓展資訊:主要包括鑒權資訊(資源操作授權策略)和資源容量等資訊(流控&配額)。

父資源與子資源

父資源與子資源是邏輯概念,用於描述同一產品所擁有資源之間的依賴關係,父資源套件含子資源,子資源從屬於父資源。明確資源間的邏輯關係,有助於子資源的資源管理。

  • 如何判斷資源是否有父資源

    如果資源中繼資料中resourceType格式為“****/****”,說明該資源存在父資源。例如產品KVStore for Redis,擁有資源Redis執行個體(DBInstance)和資料庫帳號(DBInstance/Account),其中資料庫帳號的resourceType為”DBInstance/Account“,說明資料庫帳號存在父資源,父資源的resourceType為DBInstance,即Redis執行個體。

  • 資源存在父資源,如何進行資源管理

    調用API進行資源管理操作時,如果資源存在父資源,需要在請求路徑中添加父資源資訊,詳情請參見API目錄中具體API請求參數的requestPath。

同步操作與非同步作業

同步操作與非同步作業是程式處理任務執行的兩種模式,區別在於,同步操作在任務執行完成後才返回,而非同步作業則不等待任務執行完成就返回。

一般情況下,雲控制API採用同步操作,如處理資源的查詢、列舉或更新以及中繼資料查詢等任務;資源的建立與刪除任務,因為處理任務的用時可能較長,所以雲控制API採用非同步處理,提高處理的穩定性。

雲控制API如果採用非同步作業,返回碼statusCode為“202”,您可以通過GetTask查詢非同步作業的任務狀態。