创建资源场景。
接口说明
使用限制
仅部分资源类型支持资源场景功能。更多信息,请参见支持资源场景的资源类型。
使用说明
通过资源场景功能,您可以在可视化界面上选择资源范围,并对一组资源进行复制、纳管等操作,从而简化资源管理。关于资源场景的更多信息,请参见概览。
资源复制场景
如果您需要复制一组资源及其依赖关系,可以通过创建资源复制场景复制指定范围内的所有资源,生成一套架构完全相同的资源。更多信息,请参见资源复制场景。
资源探查场景
如果您当前创建的资源之间关系错综复杂,您可以通过创建资源探查场景预览整体资源架构,或者以特定资源为起点的资源架构,从而方便管理资源。更多信息,请参见资源探查场景。
资源纳管场景
如果您需要将一组现有资源导入到一个新的资源栈中进行统一管理,可以创建资源纳管类型的资源场景。更多信息,请参见资源纳管场景。
资源迁移场景
如果您需要迁移一组资源及其依赖关系,可以创建资源迁移类型的资源场景,在资源场景中迁移资源、生成资源栈,通过资源栈查看迁移进度,待迁移完成后,您还可以删除源资源。更多信息,请参见资源迁移场景。
本文将提供一个示例,为您在杭州地域创建一个资源复制类型的资源场景,用于复制专有网络vpc-bp1m6fww66xbntjyc****
。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
ros:CreateTemplateScratch |
create |
*TemplateScratch
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
RegionId |
string |
是 |
资源场景所属的地域 ID。 您可以调用 DescribeRegions 查看最新的阿里云地域列表。 |
cn-hangzhou |
TemplateScratchType |
string |
是 |
资源场景类型,取值:
说明
当 TemplateScratchType 参数取值不同时,请求参数补充说明中可选的参数属性也不同。 更多信息,请参见下方的请求参数补充说明。 |
ArchitectureReplication |
Description |
string |
否 |
资源场景说明。 |
复制VPC资源。 |
SourceResources |
array<object> |
否 |
源资源。 如果 TemplateScratchType 为 ArchitectureDetection,设置本参数意味着探查出以指定的源资源为起点的所有资源的架构数据。例如,指定 CLB 实例 ID,会探查出其所关联的 ECS 实例、vSwitch、VPC 等资源架构数据。 最多支持设置 200 个源资源。如果 TemplateScratchType 为 ArchitectureDetection,最多设置 20 个源资源。 |
|
object |
否 |
源资源。 |
||
ResourceId |
string |
是 |
资源 ID。 |
vpc-bp1m6fww66xbntjyc**** |
ResourceType |
string |
是 |
资源类型。 |
ALIYUN::ECS::VPC |
RegionId |
string |
否 |
资源所属的地域 ID。 您可以调用 DescribeRegions 查看最新的阿里云地域列表。 说明
|
cn-beijing |
RelatedResourceTypeFilter |
array |
否 |
相关资源类型过滤列表。 |
|
string |
否 |
过滤资源类型。 |
ALIYUN::ECS::VPC |
|
SourceTag |
object |
否 |
源标签。 |
|
ResourceTags |
object |
是 |
源标签,其中键为标签键,值为标签值。
如果只希望指定标签键,则值需设置为空字符串,例如: 最多支持设置 10 个源标签。如果 TemplateScratchType 为 ArchitectureDetection,最多设置 5 个源标签。 |
{"a": "b"} |
ResourceTypeFilter |
array |
否 |
资源类型筛选器。 |
|
string |
否 |
资源类型筛选器。若指定了资源类型列表,则表示扫描指定资源类型且包含指定标签的资源;反之,则表示扫描所有包含指定标签的资源。 最多支持 20 个资源类型。 |
ALIYUN::ECS::VPC |
|
SourceResourceGroup |
object |
否 |
源资源组。 |
|
ResourceGroupId |
string |
是 |
源资源组 ID。 |
rg-acfmzawhxxc**** |
ResourceTypeFilter |
array |
否 |
资源类型筛选器。 |
|
string |
否 |
资源类型筛选器。若指定了资源类型列表,则表示扫描指定资源类型且在指定资源组的资源;反之,则表示扫描所有在指定资源组的资源。 最多支持 20 个资源类型。 |
ALIYUN::ECS::VPC |
|
PreferenceParameters |
array<object> |
否 |
资源场景配置参数。 |
|
object |
否 |
|||
ParameterKey |
string |
是 |
参数名称。 关于取值的更多信息,请参见下列的请求参数补充说明。 说明
|
DeletionPolicy |
ParameterValue |
string |
是 |
参数值。取值与 ParameterKey 对应。 关于取值的更多信息,请参见下列的请求参数补充说明。 说明
PreferenceParameters 为可选参数。如果需要指定 PreferenceParameters,则 ParameterKey 和 ParameterValue 必须同时指定。 |
Retain |
LogicalIdStrategy |
string |
否 |
逻辑 ID 生成策略,取值:
说明
默认值为 LongTypePrefixAndIndexSuffix。如果 TemplateScratchType 为 ArchitectureDetection,默认值为 LongTypePrefixAndHashSuffix。 |
LongTypePrefixAndIndexSuffix |
ClientToken |
string |
否 |
保证请求的幂等性。该值由客户端生成,并且必须是全局唯一的。长度不超过 64 个字符,可包含英文字母、数字、短划线(-)和下划线(_)。 更多信息,请参见如何保证幂等性。 |
123e4567-e89b-12d3-a456-42665544**** |
ExecutionMode |
string |
否 |
执行模式,取值:
说明
如果资源范围较大,同步执行的时间会比较长,推荐同时指定 ClientToken,以避免超时问题。 |
Sync |
Tags |
array<object> |
否 |
资源场景的标签。 |
|
object |
否 |
|||
Key |
string |
是 |
资源场景的标签键。 说明
Tags 为可选参数。如果需要指定 Tags,则 Tags.N.Key 必须指定。 |
usage |
Value |
string |
否 |
资源场景的标签值。 |
test |
ResourceGroupId |
string |
否 |
资源组 ID。如果不指定该参数,资源场景将加入默认资源组。 |
rg-acfmxazb4ph6aiy**** |
请求参数补充说明
关于公共请求参数的详情,请参见公共参数。
当TemplateScratchType
参数的取值不同,下列对应支持的 ParameterKey、ParameterValue 也不同。
资源复制场景
当 TemplateScratchType 取值为 ArchitectureReplication 时,资源复制类型的资源场景支持的 ParameterKey、ParameterValue 如下:
ParameterKey | ParameterValue |
DeletionPolicy | 资源删除策略,取值: |
RegionId | 希望复制到的目标地域 ID。若不指定,默认为当前地域。 |
ZoneId | 希望复制到的目标可用区 ID。若不指定,当同地域复制时,复制出的资源和源资源可用区保持一致;当跨地域复制时,会筛选出所有资源均支持的可用区。 |
VpcId | 希望复制到的目标专有网络 ID。若不指定,当同地域复制时,复制出的资源和源资源专有网络保持一致;当跨地域复制时,会在目标地域自动创建专有网络。 |
VSwitchId | 希望复制到的目标交换机 ID。若不指定,当同地域复制时,复制出的资源和源资源交换机保持一致;当跨地域复制时,会在目标地域自动创建交换机。 |
NamePrefix | 资源名称前缀,默认无前缀。长度 2-32 个字符。 |
DisableNameUnique | 是否禁用名称自动唯一。默认不禁用,会针对名称唯一性的资源(如 Bucket)自动添加 8 位随机码确保复制出的资源的名称唯一性。 |
InstanceDataReplication | 是否复制 ECS 实例数据,默认 false。取值:
|
InstancePeriod | 希望复制的 ECS 预付费实例的付费时长,默认同源实例。 |
InstancePeriodUnit | 希望复制的 ECS 预付费实例的付费周期,默认同源实例。取值:
|
InstanceAmount | 希望复制的 ECS 实例数量,仅在源资源为单个 ECS 实例时生效。 |
RamAttachedPolicyReplication | 是否复制关联的 RAM 策略,默认 false。取值:
|
AlbLoadBalancerEdition | 应用型负载均衡的版本,不同版本有不同功能限制和计费策略。取值:
|
AlbAddressType | 应用型负载均衡的地址类型。取值:
|
AlbAddressIpVersion | 协议版本。取值:
|
AlbZoneMappings | 可用区及交换机映射列表,最多支持添加 10 个可用区。若当前地域支持 2 个及以上的可用区,至少需要添加 2 个可用区。类型为 Json 字符串,结构同 ALB CreateLoadBalancer 的 |
SlbListenerProtocols | 传统型负载均衡实例监听协议,用来限定复制的监听协议,可设置一个或多个,使用英文逗号分隔,默认为不限定。取值:
|
当您指定 ParameterKey 为 InstanceDataReplication、ParameterValue 为 true 时,为了确保数据一致性,请您停止源实例后再复制资源。
资源探查场景
当 ArchitectureReplication 参数取值为 ArchitectureDetection 时,资源探查类型的资源场景支持的 ParameterKey、ParameterValue 如下:
ParameterKey | ParameterValue |
RegionIds | 一个或多个地域,使用","分隔。支持全局地域 |
资源纳管场景
当 ArchitectureDetection 参数取值为 ResourceImport 时,资源纳管类型的资源场景支持的 ParameterKey、ParameterValue 如下:
资源纳管类型的资源场景,必须指定 ParameterKey 为 DeletionPolicy。
ParameterKey | ParameterValue |
DeletionPolicy | 资源删除策略,取值: |
SlbListenerProtocols | 传统型负载均衡实例监听协议,用来限定纳管的监听协议,可设置一个或多个,使用英文逗号分隔,默认为不限定。取值:
|
资源迁移场景
当 ArchitectureDetection 参数的取值为 ResourceMigration 时,资源迁移类型的资源场景支持的 ParameterKey、ParameterValue 如下:
ParameterKey | ParameterValue |
RegionId | 希望迁移到的目标地域 ID。若不指定,默认为当前地域。 |
ZoneId | 希望迁移到的目标可用区 ID。若不指定,当同地域复制时,复制出的资源和源资源可用区保持一致;当跨地域复制时,会筛选出所有资源均支持的可用区。 |
VpcId | 希望迁移到的目标专有网络 ID。若不指定,当同地域复制时,复制出的资源和源资源专有网络保持一致;当跨地域复制时,会在目标地域自动创建专有网络。 |
VSwitchId | 希望迁移到的目标交换机 ID。若不指定,当同地域复制时,复制出的资源和源资源交换机保持一致;当跨地域复制时,会在目标地域自动创建交换机。 |
InstanceDataReplication | 是否迁移 ECS 实例数据,取值: |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
|||
RequestId |
string |
请求 ID。 |
84980977-22F0-5421-B30D-B201311D5DCF |
TemplateScratchId |
string |
资源场景 ID。 |
ts-7f7a704cf71c49a6**** |
示例
正常返回示例
JSON
格式
{
"RequestId": "84980977-22F0-5421-B30D-B201311D5DCF",
"TemplateScratchId": "ts-7f7a704cf71c49a6****"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。