资源编排服务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接口验证将要创建资源栈的模板。