资源编排服务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接口查询支持的资源类型列表。

模板相关接口

模板是一个JSON或YAML格式的文本文件,用于定义资源栈中的资源及资源间的依赖关系,以便创建资源栈。例如:您可以调用CreateTemplate接口创建一个包含ALIYUN::ECS::VPC资源类型的模板,然后调用CreateStack接口创建资源栈,从而创建一个VPC。

此外,您可以根据需要查询模板ID、模板内容或模板定义的资源价格。您也可以将模板共享给他人,方便多个阿里云账号共用一个模板,提升创建资源栈的效率。

API 描述
GenerateTemplatePolicy 调用GenerateTemplatePolicy接口生成模板所需的策略信息。
CreateTemplate 调用CreateTemplate接口创建自定义模板。
ValidateTemplate 调用ValidateTemplate接口验证将要创建资源栈的模板。
UpdateTemplate 调用UpdateTemplate接口更新模板。
GetTemplate 调用GetTemplate接口查询资源栈、更改集、自定义模板的模板详情。
GetTemplateEstimateCost 调用GetTemplateEstimateCost接口查询模板中创建资源的预估价格。
GetTemplateSummary 调用GetTemplateSummary接口获取新模板或者现有模板的信息。
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接口发送信号,发送故障信号时无法创建或更新资源栈。

API 描述
DescribeRegions 调用DescribeRegions接口查询地域列表。
SignalResource 调用SignalResource接口发送信号。