資源編排服務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在指定賬號和地域下創建資源棧實例。
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支持的特定功能詳情。 |