UpdateTemplateScratch_资源编排_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

资源复制场景

您可以对资源场景内容进行修改,且修改后的内容不会对之前复制生成的资源栈产生影响。 您还可以调用GenerateTemplateByScratch - 为资源场景生成模板接口为资源场景生成模板。

资源迁移场景

  • 当您仅迁移资源并未删除源资源时,如果您对资源场景进行更新,您可以通过删除源资源操作纳管更新后的资源场景内容。您还可以调用GenerateTemplateByScratch - 为资源场景生成模板接口为资源场景生成新的模板。
    说明 请确保待删除的源资源不存在除资源场景外的资源关系,否则删除不成功。
  • 当您在迁移资源后并选择删除源资源时,如果您对资源场景进行更新,您仅可以调用 GenerateTemplateByScratch 为资源场景生成模板接口为资源场景生成新的模板。

资源纳管场景

当您在纳管资源后更新资源场景内容,您仅可以调用GenerateTemplateByScratch - 为资源场景生成模板接口为资源场景生成新的模板。

资源探查场景

当您更新资源探查场景内容后,ROS 会从资源中心获取最新的数据并渲染出架构图。

本文将提供一个示例,将杭州地域的资源场景ts-7f7a704cf71c49a6****中的 VPC 资源 ID 更新为vpc-bp1m6fww66xbntjyc****

流控信息

请求速率为100/60(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
ros:UpdateTemplateScratch
Update
TemplateScratch
acs:ros:{#regionId}:{#accountId}:templatescratch/{#templatescratchId}

请求参数

字段名称字段详情
RegionIdstring

资源场景所属的地域 ID。展开详情

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
TemplateScratchIdstring

资源场景 ID。展开详情

示例值:ts-7f7a704cf71c49a6****参考取值来源:
    CreateTemplateScratch
    ListTemplateScratches
Descriptionstring

资源场景说明。

示例值:复制VPC资源。
SourceResourcesarray<object>

源资源。展开详情

SourceTagobject

源标签。展开详情

SourceResourceGroupobject

源资源组。展开详情

PreferenceParametersarray<object>

资源场景配置参数。

LogicalIdStrategystring

逻辑 ID 生成策略,取值:展开详情

示例值:LongTypePrefixAndIndexSuffix
ClientTokenstring

保证请求的幂等性。该值由客户端生成,并且必须是全局唯一的。长度不超过 64 个字符,可包含英文字母、数字、短划线(-)和下划线(_)。 展开详情

示例值:123e4567-e89b-12d3-a456-42665544****
ExecutionModestring

执行模式,取值:展开详情

示例值:Sync
ResourceGroupIdstring

资源组 ID。

示例值:rg-acfmxazb4ph6aiy****参考取值来源:
    GetStackGroup
    ListStackGroups

请求说明

请求参数补充说明

关于公共请求参数的详情,请参见公共参数

请求参数中,不同类型的资源场景支持的 ParameterKey、ParameterValue 不同。

资源复制场景

当 TemplateScratchId 参数取值为资源复制场景 ID,支持的 ParameterKey、ParameterValue 如下:

ParameterKeyParameterValue
DeletionPolicy资源删除策略,取值:
Retain:保留。将资源复制到资源栈后,在删除此资源栈时,保留原有资源。
Delete:删除。将资源复制到资源栈后,在删除此资源栈时,默认删除原有资源;若在删除确认框中选择保留部分资源,则删除未选择保留的资源。
RegionId希望复制到的目标地域。若不指定,默认为当前地域。
示例:cn-shanghai。
ZoneId希望复制到的目标可用区。若不指定,当同地域复制时,复制出的资源和源资源可用区保持一致;当跨地域复制时,会筛选出所有资源均支持的可用区。
示例:cn-shanghai-b。
VpcId希望复制到的目标专有网络。若不指定,当同地域复制时,复制出的资源和源资源专有网络保持一致;当跨地域复制时,会在目标地域自动创建专有网络。
示例:vpc-bp1hye0s8b69xokfu****。
VSwitchId希望复制到的目标交换机。若不指定,当同地域复制时,复制出的资源和源资源交换机保持一致;当跨地域复制时,会在目标地域自动创建交换机。
示例:vsw-bp11ufkwqwggtm1cj****。
InstanceDataReplication是否复制 ECS 实例数据,取值:
true:复制 ECS 实例数据。当同地域复制时,会为源实例构建自定义镜像,以此镜像创建新实例;当跨地域复制时,会为源实例构建自定义镜像,并拷贝至目标地域,以新镜像创建新实例。
false:不复制 ECS 实例数据。
说明 当您指定 ParameterKey 为 InstanceDataReplication、ParameterValue 为 true 时,为了确保数据一致性,请您停止源实例后再复制资源。

资源纳管场景

当 TemplateScratchId 参数取值为资源纳管场景 ID,支持的 ParameterKey、ParameterValue 如下:

说明 资源纳管类型的资源场景,必须指定 ParameterKey 为 DeletionPolicy。
ParameterKeyParameterValue
DeletionPolicy资源删除策略,取值:
Retain:保留。将资源纳管至资源栈后,在删除此资源栈时,保留原有资源。
Delete:删除。将资源纳管至资源栈后,在删除此资源栈时,默认删除原有资源;若在删除确认框中选择保留部分资源,则删除未选择保留的资源。

资源探查场景

当 TemplateScratchId 参数取值为资源探查场景 ID,支持的 ParameterKey、ParameterValue 如下:

ParameterKeyParameterValue
RegionIds一个或多个地域,使用","分隔。如果不指定,则为当前资源场景的地域。不允许同时指定本参数和 SourceResources。

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:221DA822-B8CF-50DF-A9D2-BA197BF97BD5
TemplateScratchIdstring

资源场景 ID。

示例值:ts-7f7a704cf71c49a6****

返回示例

变更历史

变更时间变更内容概要操作
2023-10-10
新增请求参数ResourceGroupId
2021-11-30
新增OpenAPI,更新资源场景

相关示例

调用UpdateTemplateScratch接口更新资源场景。
2022-09-19