调用UpdateTemplateScratch接口更新资源场景。

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 UpdateTemplateScratch

要执行的操作，取值：UpdateTemplateScratch。
RegionId String 是 cn-hangzhou

资源场景所属的地域ID。

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

TemplateScratchId String 是 ts-7f7a704cf71c49a6****

资源场景ID。
Description String 否 复制VPC资源。

资源场景说明。
SourceResources Array 否

源资源。
ResourceId String 是 vpc-bp1m6fww66xbntjyc****

资源ID。
ResourceType String 是 ALIYUN::ECS::VPC

资源类型。
SourceTag Object 否

源标签。
ResourceTags Map 是 {"a": "b"}

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

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

最多支持设置10个源标签。
ResourceTypeFilter Array of String 否 ALIYUN::ECS::VPC

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

最多支持20个资源类型。
SourceResourceGroup Object 否

源资源组。
ResourceGroupId String 是 rg-acfmzawhxxc****

源资源组ID。
ResourceTypeFilter Array of String 否 ALIYUN::ECS::VPC

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

最多支持20个资源类型。
PreferenceParameters Array 否

资源场景配置参数。
ParameterKey String 是 DeletionPolicy

参数名称。

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

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

参数值。取值与ParameterKey对应。

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

说明 PreferenceParameters为可选参数。如果需要指定PreferenceParameters，则ParameterKey和ParameterValue必须同时指定。
LogicalIdStrategy String 否 LongTypePrefixAndIndexSuffix

逻辑ID生成策略，取值：

  • LongTypePrefixAndIndexSuffix（默认值）：长类型前缀+索引后缀。
  • LongTypePrefixAndHashSuffix：长类型前缀+哈希后缀。
  • ShortTypePrefixAndHashSuffix：短类型前缀+哈希后缀。
ClientToken String 否 123e4567-e89b-12d3-a456-42665544****

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

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

ExecutionMode String 否 Sync

执行模式，取值：

  • Async（默认值）：异步执行。
  • Sync：同步执行。
说明 如果资源范围较大，同步执行的时间会比较长，推荐同时指定ClientToken，以避免超时问题。

请求参数补充说明

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

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

  • 资源复制类型的资源场景支持的ParameterKey、ParameterValue如下：

ParameterKey

ParameterValue

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时，为了确保数据一致性，请您停止源实例后再复制资源。
  • 资源纳管类型的资源场景支持的ParameterKey、ParameterValue如下：
    说明 资源纳管类型的资源场景，必须指定ParameterKey为DeletionPolicy。

    ParameterKey

    ParameterValue

    DeletionPolicy

    资源删除策略，取值：

    • Retain：保留。将资源纳管至资源栈后，在删除此资源栈时，保留原有资源。
    • Delete：删除。将资源纳管至资源栈后，在删除此资源栈时，默认删除原有资源；若在删除确认框中选择保留部分资源，则删除未选择保留的资源。

返回数据

名称 类型 示例值 描述
RequestId String 221DA822-B8CF-50DF-A9D2-BA197BF97BD5

请求ID。
TemplateScratchId String ts-7f7a704cf71c49a6****

资源场景ID。

示例

请求示例

http(s)://[Endpoint]/?Action=UpdateTemplateScratch
&RegionId=cn-hangzhou
&TemplateScratchId=ts-7f7a704cf71c49a6****
&SourceResources=[{"ResourceId":"vpc-bp1m6fww66xbntjyc****","ResourceType":"ALIYUN::ECS::VPC"}]
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateTemplateScratchResponse>
    <RequestId>221DA822-B8CF-50DF-A9D2-BA197BF97BD5</RequestId>
    <TemplateScratchId>ts-7f7a704cf71c49a6****</TemplateScratchId>
</UpdateTemplateScratchResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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