CreateTemplateScratch - 创建新模板创建扫描_资源编排-阿里云帮助中心

创建资源场景。

接口说明

使用说明

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

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ros:CreateTemplateScratch	Write	ROS acs:ros:{#regionId}:{#accountId}:templatescratch/*	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	资源场景所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。	cn-hangzhou
TemplateScratchType	string	是	资源场景类型，取值： ResourceImport：资源纳管。 ArchitectureReplication：资源复制。 ResourceMigration：资源迁移。	ArchitectureReplication
Description	string	否	资源场景说明。	复制VPC资源。
SourceResources	array	否	源资源。
	object	否	源资源。
ResourceId	string	是	资源ID。	vpc-bp1m6fww66xbntjyc****
ResourceType	string	是	资源类型。	ALIYUN::ECS::VPC
SourceTag	object	否	源标签。
ResourceTags	object	是	源标签，其中键为标签键，值为标签值。如果只希望指定标签键，则值需设置为空字符串，例如：`{"TagKey": ""}`。最多支持设置10个源标签。
ResourceTypeFilter	array	否	资源类型筛选器。
	string	否	资源类型筛选器。若指定了资源类型列表，则表示扫描指定资源类型且包含指定标签的资源；反之，则表示扫描所有包含指定标签的资源。最多支持20个资源类型。	ALIYUN::ECS::VPC
SourceResourceGroup	object	否	源资源组。
ResourceGroupId	string	是	源资源组ID。	rg-acfmzawhxxc****
ResourceTypeFilter	array	否	资源类型筛选器。
	string	否	资源类型筛选器。若指定了资源类型列表，则表示扫描指定资源类型且在指定资源组的资源；反之，则表示扫描所有在指定资源组的资源。最多支持20个资源类型。	ALIYUN::ECS::VPC
PreferenceParameters	array	否	资源场景配置参数。
	object	否
ParameterKey	string	是	参数名称。关于取值的更多信息，请参见请求参数补充说明。说明 PreferenceParameters为可选参数。如果需要指定PreferenceParameters，则ParameterKey和ParameterValue必须同时指定。当TemplateScratchType取值为ResourceImport时，必须指定ParameterKey为DeletionPolicy。	DeletionPolicy
ParameterValue	string	是	参数值。取值与ParameterKey对应。关于取值的更多信息，请参见请求参数补充说明。说明PreferenceParameters为可选参数。如果需要指定PreferenceParameters，则ParameterKey和ParameterValue必须同时指定。	Retain
LogicalIdStrategy	string	否	逻辑ID生成策略，取值： LongTypePrefixAndIndexSuffix（默认值）：长类型前缀+索引后缀。 LongTypePrefixAndHashSuffix：长类型前缀+哈希后缀。 ShortTypePrefixAndHashSuffix：短类型前缀+哈希后缀。	LongTypePrefixAndIndexSuffix
ClientToken	string	否	保证请求的幂等性。该值由客户端生成，并且必须是全局唯一的。长度不超过64个字符，可包含英文字母、数字、短划线（-）和下划线（_）。更多信息，请参见如何保证幂等性。	123e4567-e89b-12d3-a456-42665544****
ExecutionMode	string	否	执行模式，取值： Async（默认值）：异步执行。 Sync：同步执行。说明如果资源范围较大，同步执行的时间会比较长，推荐同时指定ClientToken，以避免超时问题。	Sync
Tags	array	否	资源场景的标签。
	object	否
Key	string	是	资源场景的标签键。说明Tags为可选参数。如果需要指定Tags，则Tags.N.Key必须指定。	usage
Value	string	否	资源场景的标签值。	test

请求参数补充说明

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

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

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

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

说明当您指定ParameterKey为InstanceDataReplication、ParameterValue为true时，为了确保数据一致性，请您停止源实例后再复制资源。

资源纳管类型的资源场景支持的ParameterKey、ParameterValue如下：
说明资源纳管类型的资源场景，必须指定ParameterKey为DeletionPolicy。

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

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求ID。	84980977-22F0-5421-B30D-B201311D5DCF
TemplateScratchId	string	资源场景ID。	ts-7f7a704cf71c49a6****

示例

正常返回示例

JSON格式

{
  "RequestId": "84980977-22F0-5421-B30D-B201311D5DCF",
  "TemplateScratchId": "ts-7f7a704cf71c49a6****"
}

错误码

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