文档

UpdateTemplateScratch - 更新资源场景

更新时间:

更新资源场景。

接口说明

资源复制场景

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

资源迁移场景

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

资源纳管场景

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

资源探查场景

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

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

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ros:UpdateTemplateScratchWrite
  • TemplateScratch
    acs:ros:{#regionId}:{#accountId}:templatescratch/{#templatescratchId}

请求参数

名称类型必填描述示例值
RegionIdstring

资源场景所属的地域 ID。

您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
TemplateScratchIdstring

资源场景 ID。

当您输入的资源场景 ID 为不同的场景类型时,可选的请求参数属性也不同。更多信息,请参见下列的请求参数补充说明。

说明 您可以调用ListTemplateScratches - 查询资源场景列表查看资源场景 ID。
ts-7f7a704cf71c49a6****
Descriptionstring

资源场景说明。

复制VPC资源。
SourceResourcesobject []

源资源。

说明 SourceResources、SourceTag 和 SourceResourceGroup 参数仅需设置其中一个。
ResourceIdstring

资源 ID。

vpc-bp1m6fww66xbntjyc****
ResourceTypestring

资源类型。

ALIYUN::ECS::VPC
SourceTagobject

源标签。

说明 SourceResources、SourceTag 和 SourceResourceGroup 参数仅需设置其中一个。
ResourceTagsobject

源标签,其中键为标签键,值为标签值。

如果只希望指定标签键,则值需设置为空字符串,例如:{"TagKey": ""}。

最多支持设置 10 个源标签。如果 TemplateScratchType 为 ArchitectureDetection,最多设置 5 个源标签。

{"a": "b"}
ResourceTypeFilterarray

资源类型筛选器。

string

资源类型筛选器。若指定了资源类型列表,则表示扫描指定资源类型且包含指定标签的资源;反之,则表示扫描所有包含指定标签的资源。

最多支持 20 个资源类型。

ALIYUN::ECS::VPC
SourceResourceGroupobject

源资源组。

说明 SourceResources、SourceTag 和 SourceResourceGroup 参数仅需设置其中一个。
ResourceGroupIdstring

源资源组 ID。

rg-acfmzawhxxc****
ResourceTypeFilterarray

资源类型筛选器。

string

资源类型筛选器。若指定了资源类型列表,则表示扫描指定资源类型且在指定资源组中的资源;反之,则表示扫描所有在指定资源组中的资源。

最多支持 20 个资源类型。

ALIYUN::ECS::VPC
PreferenceParametersobject []

资源场景配置参数。

ParameterKeystring

参数名称。

关于取值的更多信息,请参见请求参数补充说明

说明
  • PreferenceParameters 为可选参数。如果需要指定 PreferenceParameters,则 ParameterKey 和 ParameterValue 必须同时指定。
  • 当 TemplateScratchType 取值为 ResourceImport 时,必须指定 ParameterKey 为 DeletionPolicy。
  • DeletionPolicy
    ParameterValuestring

    参数值。取值与 ParameterKey 对应。

    关于取值的更多信息,请参见请求参数补充说明

    说明 PreferenceParameters 为可选参数。如果需要指定 PreferenceParameters,则 ParameterKey 和 ParameterValue 必须同时指定。
    Retain
    LogicalIdStrategystring

    逻辑 ID 生成策略,取值:

    • LongTypePrefixAndIndexSuffix:长类型前缀+索引后缀。

    • LongTypePrefixAndHashSuffix:长类型前缀+哈希后缀。

    • ShortTypePrefixAndHashSuffix:短类型前缀+哈希后缀。

    说明 默认值为 LongTypePrefixAndIndexSuffix。如果 TemplateScratchType 为 ArchitectureDetection,默认值为 LongTypePrefixAndHashSuffix。
    LongTypePrefixAndIndexSuffix
    ClientTokenstring

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

    更多信息,请参见如何保证幂等性

    123e4567-e89b-12d3-a456-42665544****
    ExecutionModestring

    执行模式,取值:

    • Async(默认值):异步执行。

    • Sync:同步执行。

    说明 如果资源范围较大,同步执行的时间会比较长,推荐同时指定 ClientToken,以避免超时问题。
    Sync
    ResourceGroupIdstring

    资源组 ID。

    rg-acfmxazb4ph6aiy****

    请求参数补充说明

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

    请求参数中,不同类型的资源场景支持的 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。

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    221DA822-B8CF-50DF-A9D2-BA197BF97BD5
    TemplateScratchIdstring

    资源场景 ID。

    ts-7f7a704cf71c49a6****

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "221DA822-B8CF-50DF-A9D2-BA197BF97BD5",
      "TemplateScratchId": "ts-7f7a704cf71c49a6****"
    }

    错误码

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2023-10-10OpenAPI 入参发生变更看变更集
    变更项变更内容
    入参OpenAPI 入参发生变更
      新增入参:ResourceGroupId