CreateTemplateScratch
创建资源场景
服务地址:
华东1 金融云
输入参数
只看必填
RegionId资源场景所属的地域ID
TemplateScratchType资源场景类型
Description资源场景说明
SourceResources源资源
0源资源
ResourceId资源ID
ResourceType资源类型
RegionId资源所属的地域ID
RelatedResourceTypeFilter相关资源类型过滤列表
0过滤资源类型
SourceTag源标签
ResourceTags源标签
ResourceTypeFilter资源类型筛选器
0资源类型筛选器
SourceResourceGroup源资源组
ResourceGroupId源资源组ID
ResourceTypeFilter资源类型筛选器
0资源类型筛选器
PreferenceParameters资源场景配置参数
0
ParameterKey参数名称
ParameterValue参数值
LogicalIdStrategy逻辑ID生成策略
ExecutionMode执行模式
Tags资源场景的标签
0
Key资源场景的标签键
Value资源场景的标签值
ResourceGroupId资源组ID
幂等性参数
ClientToken保证请求的幂等性
插件下载了解更多
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.

接口说明

使用限制

仅部分资源类型支持资源场景功能。更多信息,请参见支持资源场景的资源类型

使用说明

通过资源场景功能,您可以在可视化界面上选择资源范围,并对一组资源进行复制、纳管等操作,从而简化资源管理。关于资源场景的更多信息,请参见概览

资源复制场景

如果您需要复制一组资源及其依赖关系,可以通过创建资源复制场景复制指定范围内的所有资源,生成一套架构完全相同的资源。更多信息,请参见资源复制场景

资源探查场景

如果您当前创建的资源之间关系错综复杂,您可以通过创建资源探查场景预览整体资源架构,或者以特定资源为起点的资源架构,从而方便管理资源。更多信息,请参见资源探查场景

资源纳管场景

如果您需要将一组现有资源导入到一个新的资源栈中进行统一管理,可以创建资源纳管类型的资源场景。更多信息,请参见资源纳管场景

资源迁移场景

如果您需要迁移一组资源及其依赖关系,可以创建资源迁移类型的资源场景,在资源场景中迁移资源、生成资源栈,通过资源栈查看迁移进度,待迁移完成后,您还可以删除源资源。更多信息,请参见资源迁移场景

本文将提供一个示例,为您在杭州地域创建一个资源复制类型的资源场景,用于复制专有网络vpc-bp1m6fww66xbntjyc****

请求参数

字段名称字段详情
RegionIdstring

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

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

资源场景类型,取值:展开详情

示例值:ArchitectureReplication参考取值来源:
    GetTemplateScratch
    ListTemplateScratches
Descriptionstring

资源场景说明。

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

源资源。展开详情

SourceTagobject

源标签。

SourceResourceGroupobject

源资源组。

PreferenceParametersarray<object>

资源场景配置参数。

LogicalIdStrategystring

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

示例值:LongTypePrefixAndIndexSuffix
ClientTokenstring

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

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

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

示例值:Sync
Tagsarray<object>

资源场景的标签。

子级条数 <= 20
ResourceGroupIdstring

资源组 ID。如果不指定该参数,资源场景将加入默认资源组。

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

请求说明

请求参数补充说明

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

TemplateScratchType参数的取值不同,下列对应支持的 ParameterKey、ParameterValue 也不同。

资源复制场景

当 TemplateScratchType 取值为 ArchitectureReplication 时,资源复制类型的资源场景支持的 ParameterKey、ParameterValue 如下:

ParameterKeyParameterValue
DeletionPolicy资源删除策略,取值:
Retain:保留。将资源复制到资源栈后,在删除此资源栈时,保留原有资源。
Delete:删除。将资源复制到资源栈后,在删除此资源栈时,默认删除原有资源;若在删除确认框中选择保留部分资源,则删除未选择保留的资源。
RegionId希望复制到的目标地域 ID。若不指定,默认为当前地域。
示例:cn-shanghai。
ZoneId希望复制到的目标可用区 ID。若不指定,当同地域复制时,复制出的资源和源资源可用区保持一致;当跨地域复制时,会筛选出所有资源均支持的可用区。
示例:cn-shanghai-b。
VpcId希望复制到的目标专有网络 ID。若不指定,当同地域复制时,复制出的资源和源资源专有网络保持一致;当跨地域复制时,会在目标地域自动创建专有网络。
示例:vpc-bp1hye0s8b69xokfu****。
VSwitchId希望复制到的目标交换机 ID。若不指定,当同地域复制时,复制出的资源和源资源交换机保持一致;当跨地域复制时,会在目标地域自动创建交换机。
示例:vsw-bp11ufkwqwggtm1cj****。
NamePrefix资源名称前缀,默认无前缀。长度 2-32 个字符。
DisableNameUnique是否禁用名称自动唯一。默认不禁用,会针对名称唯一性的资源(如 Bucket)自动添加 8 位随机码确保复制出的资源的名称唯一性。
InstanceDataReplication是否复制 ECS 实例数据,默认 false。取值:
  • true:复制 ECS 实例数据。当同地域复制时,会为源实例构建自定义镜像,以此镜像创建新实例;当跨地域复制时,会为源实例构建自定义镜像,并拷贝至目标地域,以新镜像创建新实例。
  • false:不复制 ECS 实例数据。
InstancePeriod希望复制的 ECS 预付费实例的付费时长,默认同源实例。
InstancePeriodUnit希望复制的 ECS 预付费实例的付费周期,默认同源实例。取值:
  • Week:周。
  • Month:月。
  • Year:年。
InstanceAmount希望复制的 ECS 实例数量,仅在源资源为单个 ECS 实例时生效。
RamAttachedPolicyReplication是否复制关联的 RAM 策略,默认 false。取值:
  • true:true:复制 RAM 用户、角色、组所关联的策略。
  • false:不复制关联的 RAM 策略。
SlbListenerProtocols传统型负载均衡实例监听协议,用来限定复制的监听协议,可设置一个或多个,使用英文逗号分隔,默认为不限定。取值:
  • tcp
  • udp
  • http
  • https
示例:tcp,udp。
说明 当您指定 ParameterKey 为 InstanceDataReplication、ParameterValue 为 true 时,为了确保数据一致性,请您停止源实例后再复制资源。

资源探查场景

当 ArchitectureReplication 参数取值为 ArchitectureDetection 时,资源探查类型的资源场景支持的 ParameterKey、ParameterValue 如下:

ParameterKeyParameterValue
RegionIds一个或多个地域,使用","分隔。支持全局地域global。如果不指定,则为当前资源场景的地域。

资源纳管场景

当 ArchitectureDetection 参数取值为 ResourceImport 时,资源纳管类型的资源场景支持的 ParameterKey、ParameterValue 如下:

说明 资源纳管类型的资源场景,必须指定 ParameterKey 为 DeletionPolicy。
ParameterKeyParameterValue
DeletionPolicy资源删除策略,取值:
Retain:保留。将资源纳管至资源栈后,在删除此资源栈时,保留原有资源。
Delete:删除。将资源纳管至资源栈后,在删除此资源栈时,默认删除原有资源;若在删除确认框中选择保留部分资源,则删除未选择保留的资源。
SlbListenerProtocols传统型负载均衡实例监听协议,用来限定纳管的监听协议,可设置一个或多个,使用英文逗号分隔,默认为不限定。取值:
  • tcp
  • udp
  • http
  • https
示例:tcp,udp。

资源迁移场景

当 ArchitectureDetection 参数的取值为 ResourceMigration 时,资源迁移类型的资源场景支持的 ParameterKey、ParameterValue 如下:

ParameterKeyParameterValue
RegionId希望迁移到的目标地域 ID。若不指定,默认为当前地域。
示例:cn-shanghai。
ZoneId希望迁移到的目标可用区 ID。若不指定,当同地域复制时,复制出的资源和源资源可用区保持一致;当跨地域复制时,会筛选出所有资源均支持的可用区。
示例:cn-shanghai-b。
VpcId希望迁移到的目标专有网络 ID。若不指定,当同地域复制时,复制出的资源和源资源专有网络保持一致;当跨地域复制时,会在目标地域自动创建专有网络。
示例:vpc-bp1hye0s8b69xokfu****。
VSwitchId希望迁移到的目标交换机 ID。若不指定,当同地域复制时,复制出的资源和源资源交换机保持一致;当跨地域复制时,会在目标地域自动创建交换机。
示例:vsw-bp11ufkwqwggtm1cj****。
InstanceDataReplication是否迁移 ECS 实例数据,取值:
true:迁移 ECS 实例数据。当同地域迁移时,会为源实例构建自定义镜像,以此镜像创建新实例;当跨地域复制时,会为源实例构建自定义镜像,并拷贝至目标地域,以新镜像创建新实例。
false:不迁移 ECS 实例数据。

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:84980977-22F0-5421-B30D-B201311D5DCF
TemplateScratchIdstring

资源场景 ID。

示例值:ts-7f7a704cf71c49a6****
变更历史
变更时间变更内容概要操作
2024-04-24
变更请求参数SourceResources
2023-10-19
变更请求参数SourceResources
2023-10-10
新增请求参数ResourceGroupId
2022-11-21
新增请求参数Tags
  • 1
  • 2
  • 10 条/页