资源编排提供的API及用法_资源编排(ROS)-阿里云帮助中心

本产品（ROS/2019-09-10）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。

在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

AI任务相关接口

API	标题	API概述
CreateAITask	创建AI任务	创建AI任务以执行特定的自动化工作流，如生成、修复模板或部署资源栈。
GetAITask	查询AI任务详情	指定AI任务ID，获取AI任务的详细信息。
ListAITasks	查询AI任务列表	查询AI任务列表。
ListAITaskEvents	查询AI任务的事件	查询AI任务的事件。

资源栈相关接口

API	标题	API概述
CreateStack	创建资源栈	使用资源编排模板创建资源栈，完成一组资源的创建。
DeleteStack	删除资源栈	删除指定资源栈，可以选择是否保留资源。
UpdateStack	更新资源栈	更新已创建资源栈的资源信息。
ContinueCreateStack	重新创建资源栈	资源栈创建失败后，继续创建资源栈。
GetStack	查询资源栈信息	查询资源栈信息。
ListStacks	查询资源栈列表	查询资源栈列表。
CancelUpdateStack	取消更新资源栈	当您的资源栈正处于更新中或创建中且操作尚未完成，您可以调用该接口取消更新资源栈操作。
CancelStackOperation	取消资源栈操作	取消资源栈操作。
SetDeletionProtection	修改资源栈的删除保护属性	修改资源栈的删除保护属性。
ListStackEvents	查询资源栈及栈内资源的事件	查询资源栈及栈内资源的事件。
ListStackOperationRisks	检测资源栈操作可能涉及的风险及原因	检测进行资源栈操作可能涉及的风险，并返回风险原因或缺失项。
PreviewStack	预览指定模板将要创建或更新的资源栈信息	预览指定模板将要创建或更新的资源栈信息，验证模板资源的准确性。

资源相关接口

API	标题	API概述
ListStackResources	查询资源栈的资源列表	查询指定资源栈的资源列表。
GetStackResource	查询某个资源栈的资源	查询某个资源栈的资源。
MoveResourceGroup	修改资源所属的资源组	修改资源所属的资源组。

资源场景相关接口

API	标题	API概述
CreateTemplateScratch	创建资源场景	创建资源场景。
DeleteTemplateScratch	删除资源场景	删除资源场景。
UpdateTemplateScratch	更新资源场景	更新资源场景。
ListTemplateScratches	查询资源场景列表	查询资源场景列表。
GetTemplateScratch	获取资源场景详情	获取资源场景详情。
GenerateTemplateByScratch	为资源场景生成模板	为资源场景生成模板。

模板相关接口

API	标题	API概述
CreateTemplate	创建自定义模板	创建自定义的模板。
DeleteTemplate	删除模板	删除指定模板，如果已将模板共享给其他阿里云账号，需要取消共享后才能删除。
UpdateTemplate	更新模板	通过指定模板地址或模板详情更新模板。
GetTemplate	查询模板详情	指定资源栈、资源栈组、更改集、自定义模板其中任意信息获取模板详情。
ListTemplates	查询模板列表	查询私有与共享的模板列表。
ListTemplateVersions	查询模板的版本列表	通过查询指定模板获取模板的版本列表详情。
GetTemplateParameterConstraints	获取模版参数约束	查询模板参数的取值。
SetTemplatePermission	共享模板或取消共享模板	为指定模板设置共享或取消共享。
GetTemplateEstimateCost	查询模板中创建资源的预估价格	通过指定模板和模板参数查询创建资源栈的预估价格。
GetTemplateSummary	获取新模板或者现有模板的信息	通过指定模板、资源栈、资源栈组、更改集其中任意信息查询模板资源详情。
ValidateTemplate	验证将要创建资源栈的模板	通过指定模板地址或模板内容验证将要创建资源栈的模板。
GenerateTemplatePolicy	生成模板所需的策略信息	通过指定模板生成模板所需的策略信息。

资源栈策略相关接口

API	标题	API概述
SetStackPolicy	设置资源栈策略	为指定资源栈配置资源策略。
GetStackPolicy	获取资源栈策略	在一个阿里云地域下查询指定资源栈策略详情。

更改集相关接口

API	标题	API概述
CreateChangeSet	创建更改集	为资源栈创建更改集，您可以在执行更改之前查看对应更改内容。
DeleteChangeSet	删除更改集	为已创建更改集的资源栈删除更改集。
GetChangeSet	查询更改集信息	查询指定更改集信息，可以选择是否获取对应模板详情。
ListChangeSets	查询更改集列表	查询已创建的更改集列表详情。
ExecuteChangeSet	执行更改集	对资源栈执行更改集，资源变更即可生效。

资源栈组相关接口

API	标题	API概述
CreateStackGroup	创建资源栈组	使用资源编排模板创建资源栈组，通过资源栈组，可以在多个阿里云账号中跨地域创建资源栈。
DeleteStackGroup	删除资源栈组	删除已创建的资源栈组。
UpdateStackGroup	更新资源栈组	更新已创建的资源栈组。
ListStackGroups	查询资源栈组列表	在一个阿里云地域下查询资源栈组列表详情。
GetStackGroup	查询指定资源栈组的信息	在一个阿里云地域下根据资源栈组名称查询资源栈组详情。
CreateStackInstances	在指定账号和地域下创建资源栈实例	为一个或多个账号在指定地域下创建资源栈实例。
DeleteStackInstances	删除特定账号和地域下的资源栈实例	为一个或多个账号在指定地域下删除资源栈实例，可以选择是否保留资源。
UpdateStackInstances	在特定账号和地域下更新资源栈实例	为一个或多个账号在指定地域下更新资源栈实例。
GetStackInstance	查询资源栈实例信息	查询指定资源栈组关联的资源栈实例详情。
StopStackGroupOperation	停止资源栈组操作	停止资源栈组正在进行的操作。
ListStackInstances	查询指定资源栈组关联的资源栈实例列表	在一个阿里云地域下查询指定资源栈组关联的资源栈实例列表详情。
GetStackGroupOperation	查询资源栈组操作的信息	在一个阿里云地域下查询指定资源栈组的操作详情。
ListStackGroupOperations	查询资源栈组操作列表	在一个阿里云地域下查询资源栈组操作列表详情。
ListStackGroupOperationResults	查询资源栈组操作结果列表	在一个阿里云地域下查询指定资源栈组操作的结果列表详情。
ImportStacksToStackGroup	将资源栈导入至资源栈组	将多个不同账号下的资源栈导入至资源栈组。

偏差检测相关接口

API	标题	API概述
UpdateStackTemplateByResources	修正资源栈模板	通过执行偏差检测，消除资源栈的偏差。
GetStackDriftDetectionStatus	查询偏差检测的状态	在一个阿里云地域下根据偏差检测ID查询偏差检查状态。
ListStackResourceDrifts	查询资源栈的资源偏差详情	在一个阿里云地域下查询资源栈的资源偏差详情。
DetectStackDrift	对资源栈进行偏差检测	对资源栈进行偏差检测，可以限定具体资源，以便确定资源栈是否已偏离其预期的模板配置。
DetectStackGroupDrift	对资源栈组进行偏差检测	对资源栈组进行偏差检测，以便确定资源栈组是否已偏离其预期的模板配置。
DetectStackResourceDrift	对资源进行偏差检测	对资源进行偏差检测，以便确定资源是否已偏离其预期的模板配置。

标签相关接口

API	标题	API概述
TagResources	为指定的资源创建并绑定标签	指定一个或多个资源创建并绑定标签。
ListTagResources	查询资源已经绑定的标签	在一个阿里云地域下查询模板或资源栈中一个或多个资源已经绑定的标签。
ListTagKeys	查询标签键	在一个阿里云地域下查询资源栈或模板的标签键。
ListTagValues	查询指定标签键对应的标签值	在一个阿里云地域下查询模板或资源栈中指定标签键对应的标签值。
UntagResources	解绑并删除标签	为指定的一个或多个资源统一解绑并删除标签。

诊断相关接口

API	标题	API概述
CreateDiagnostic	创建诊断	创建诊断任务进行一键诊断。
GetDiagnostic	查询诊断详情	指定诊断报告ID，获取诊断的详细信息。
ListDiagnostics	查询诊断列表	查询诊断列表。
DeleteDiagnostic	删除诊断	删除诊断记录。

资源类型相关接口

API	标题	API概述
RegisterResourceType	注册资源类型	创建新的资源类型，或为已有资源类型增加一个新版本。
SetResourceType	修改资源类型	修改资源类型或资源类型某个版本的相关描述。
DeregisterResourceType	注销资源类型	删除资源类型，或删除已有资源类型的某个版本。
ListResourceTypes	查询支持的资源类型列表	查询支持的资源类型列表。
GetResourceTypeTemplate	查询资源类型的资源模板	根据资源类型生成一个示例模板。
GetResourceType	查询资源类型的详细信息	通过指定资源类型查询详细信息。
ListResourceTypeVersions	查询资源类型版本列表	查询资源类型版本列表，包括用户自己创建的和ROS提供的资源类型。
ListResourceTypeRegistrations	查询资源注册记录	查询资源注册记录列表。

其他相关接口

API	标题	API概述
DescribeRegions	查询地域列表	查询可选地域列表。
SignalResource	发送信号	您可以调用本接口对指定资源栈的资源发送信号，与ALIYUN::ROS::WaitCondition配合使用以控制资源栈的执行流程。
GetServiceProvisions	查询服务开通状态	查询服务开通状态和服务角色信息。
GetFeatureDetails	获取特定功能的详情	查询ROS支持的特定功能详情。