全部產品
Search
文件中心

:API概覽

更新時間:Jun 19, 2024

Resource Orchestration Service服務ROS(Resource Orchestration Service)提供以下API介面。

資源棧相關介面

您可以使用模板定義資源棧中的資源及資源間的依賴關係,然後建立資源棧。建立完成後,您可以查詢、更新或刪除資源棧。

API描述
PreviewStack調用PreviewStack介面預覽指定模板將要建立的資源棧資訊。
CreateStack調用CreateStack介面建立資源棧。
ContinueCreateStack資源棧建立失敗後,調用ContinueCreateStack介面重新建立資源棧。
SetDeletionProtection調用SetDeletionProtection介面修改資源棧的刪除保護屬性。
UpdateStack調用UpdateStack介面更新資源棧。
CancelUpdateStack調用CancelUpdateStack介面取消更新資源棧。
GetStack調用GetStack介面查詢資源棧資訊。
ListStacks調用ListStacks介面查詢資源棧列表。
ListStackEvents調用ListStackEvents介面查詢資源棧及棧內資源的事件。
ListStackOperationRisks調用ListStackOperationRisks介面檢測刪除資源棧操作可能涉及的高風險資源,並返回每個資源對應的風險原因。
DeleteStack調用DeleteStack介面刪除資源棧。

資源相關介面

ROS支援管理多種資源。您可以根據資源類型查詢資源的模板,也可以查詢資源類型詳情或特定資源棧的資源詳情,以便快速擷取ROS中的資源資訊。

ROS支援的資源類型,請參見資源類型索引

API描述
GetResourceTypeTemplate調用GetResourceTypeTemplate介面根據資源類型查詢該資源的模板。
ListStackResources調用ListStackResources介面查詢某個資源棧的資源清單。
GetStackResource調用GetStackResource介面查詢某個資源棧的資源。
GetResourceType調用GetResourceType介面查詢資源類型的詳細資料。
ListResourceTypes調用ListResourceTypes介面查詢支援的資源類型列表。
MoveResourceGroup調用MoveResourceGroup介面修改資源所屬的資源群組。

資源情境相關介面

通過資源情境功能,您可以在可視化介面上選擇資源範圍,並對一組資源進行複製、納管等操作,從而簡化資源管理。

API描述
CreateTemplateScratch調用CreateTemplateScratch介面建立資源情境。
UpdateTemplateScratch調用UpdateTemplateScratch介面更新資源情境。
ListTemplateScratches調用ListTemplateScratches介面查詢資源情境列表。
GetTemplateScratch調用GetTemplateScratch介面擷取資源情境詳情。
DeleteTemplateScratch調用DeleteTemplateScratch介面刪除資源情境。
GenerateTemplateByScratch調用GenerateTemplateByScratch介面為資源情境產生模板。

模板相關介面

模板是一個JSON或YAML格式的文字檔,用於定義資源棧中的資源及資源間的依賴關係,以便建立資源棧。例如:您可以調用CreateTemplate介面建立一個包含ALIYUN::ECS::VPC資源類型的模板,然後調用CreateStack介面建立資源棧,從而建立一個VPC。

此外,您可以根據需要查詢範本ID、模板內容或模板定義的資源價格。您也可以將模板共用給他人,方便多個阿里雲帳號共用一個模板,提升建立資源棧的效率。

API描述
GenerateTemplatePolicy調用GenerateTemplatePolicy介面產生模板所需的策略資訊。
CreateTemplate調用CreateTemplate介面建立自訂模板。
ValidateTemplate調用ValidateTemplate介面驗證將要建立資源棧的模板。
UpdateTemplate調用UpdateTemplate介面更新模板。
GetTemplate調用GetTemplate介面查詢資源棧、更改集、自訂模板的模板詳情。
GetTemplateEstimateCost調用GetTemplateEstimateCost介面查詢範本中建立資源的預估價格。
GetTemplateSummary調用GetTemplateSummary介面擷取新模板或者現有模板的資訊。
GetTemplateParameterConstraints調用GetTemplateParameterConstraints介面查詢範本參數的取值。
ListTemplates調用ListTemplates介面查詢範本列表。
ListTemplateVersions調用ListTemplateVersions介面查詢範本的版本列表。
SetTemplatePermission調用SetTemplatePermission介面共用模板或不共用模板。
DeleteTemplate調用DeleteTemplate介面刪除模板。

資源棧策略相關介面

資源棧策略是一個JSON或YAML格式的文字檔,用於定義可對指定資源執行的更新操作,防止資源棧資源在資源棧更新過程中被意外更新或刪除。您可以設定或查詢資源棧策略。

API描述
SetStackPolicy調用SetStackPolicy介面設定資源棧策略。
GetStackPolicy調用GetStackPolicy介面擷取資源棧策略。

更改集相關介面

當您需要更新正在啟動並執行資源棧時,可以建立並執行更改集。

API描述
CreateChangeSet調用CreateChangeSet介面建立更改集。
ExecuteChangeSet調用ExecuteChangeSet介面執行更改集。
GetChangeSet調用GetChangeSet介面查詢更改集資訊。
ListChangeSets調用ListChangeSets介面查詢更改集列表。
DeleteChangeSet調用DeleteChangeSet介面刪除更改集。

資源棧組相關介面

資源棧組是針對ROS資源棧的嵌入式管理單元。您可以使用模板建立資源棧組,以便在多個阿里雲帳號中跨地區建立資源棧。您也可以根據需求查詢資源棧組資訊、資源棧組操作資訊。

當您調用CreateStackGroup介面建立資源棧組後,可以調用CreateStackInstances在指定帳號和地區下建立資源棧執行個體。

說明 調用DeleteStackGroup刪除資源棧組前,需要先調用DeleteStackInstances刪除資源棧組中的所有資源棧執行個體。
API描述
CreateStackGroup調用CreateStackGroup介面建立資源棧組。
UpdateStackGroup調用UpdateStackGroup介面更新資源棧組。
GetStackGroup調用GetStackGroup介面查詢指定資源棧組的資訊。
ListStackGroups調用ListStackGroups介面查詢資源棧組列表。
GetStackGroupOperation調用GetStackGroupOperation介面查詢資源棧組操作的資訊。
ListStackGroupOperations調用ListStackGroupOperations介面查詢資源棧組巨集指令清單。
ListStackGroupOperationResults調用ListStackGroupOperationResults介面查詢資源棧組操作結果清單。
StopStackGroupOperation調用StopStackGroupOperation介面停止資源棧組操作。
CreateStackInstances調用CreateStackInstances介面在指定帳號和地區下建立資源棧執行個體。
UpdateStackInstances調用UpdateStackInstances介面在特定帳號和地區下更新資源棧執行個體。
GetStackInstance調用GetStackInstance介面查詢指定資源棧組關聯的資源棧執行個體的詳細資料。
ListStackInstances調用ListStackInstances介面查詢指定資源棧組關聯的資源棧執行個體列表。
DeleteStackInstances調用DeleteStackInstances介面刪除特定帳號和地區下的資源棧執行個體。
DeleteStackGroup調用DeleteStackGroup介面刪除資源棧組。

偏差檢測相關介面

當您在ROS之外更改資源配置時,將導致資源棧或資源棧組出現偏差。您可以進行偏差檢測,並及時糾正偏差。例如:您可以調用DetectStackDrift對資源棧進行偏差檢測,如果資源棧存在偏差,則可以調用UpdateStackTemplateByResources介面修正資源棧模板,消除資源棧的偏差。

API描述
DetectStackResourceDrift調用DetectStackResourceDrift介面對資源進行偏差檢測。
DetectStackDrift調用DetectStackDrift介面對資源棧進行偏差檢測。
DetectStackGroupDrift調用DetectStackGroupDrift介面對資源棧組進行偏差檢測。
GetStackDriftDetectionStatus調用GetStackDriftDetectionStatus介面查詢偏差檢測的狀態。
ListStackResourceDrifts調用ListStackResourceDrifts介面查詢資源棧的資源偏差詳情。
UpdateStackTemplateByResources調用UpdateStackTemplateByResources介面修正資源棧模板,消除資源棧的偏差。

標籤相關介面

您可以為資源棧、資源棧組或模板綁定標籤,方便對他們進行分類和統一管理。

API描述
TagResources調用TagResources介面為指定的ROS資源清單建立並綁定標籤。
ListTagResources調用ListTagResources介面查詢一個或多個ROS資源已經綁定的標籤。
ListTagKeys調用ListTagKeys介面查詢標籤鍵。
ListTagValues調用ListTagValues介面查詢指定標籤鍵對應的標籤值。
UntagResources調用UntagResources介面為指定的ROS資源清單統一解除綁定並刪除標籤。

其他介面

當您建立資源棧、資源棧組或資源棧執行個體時,需要指定RegionId,此時需要調用DescribeRegions擷取地區列表。

當您建立或更新資源棧時,可以調用SignalResource介面發送訊號,發送故障訊號時無法建立或更新資源棧。

此外,您可以調用GetServiceProvisions介面同時查詢多個雲端服務的開通狀態和服務角色資訊,調用GetFeatureDetails介面查詢ROS支援的特定功能詳情。

API描述
DescribeRegions調用DescribeRegions介面查詢地區列表。
SignalResource調用SignalResource介面發送訊號。
GetServiceProvisions調用GetServiceProvisions介面查詢服務開通狀態和服務角色資訊。
GetFeatureDetails調用GetFeatureDetails介面查詢ROS支援的特定功能詳情。