备案控制台
文档
产品文档
输入文档关键字查找
首页 资源编排 开发参考 API参考 API目录 资源场景相关接口 CreateTemplateScratch - 创建资源场景

CreateTemplateScratch - 创建资源场景

更新时间：
一键部署
产品详情
相关技术圈
我的收藏

创建资源场景。

接口说明

使用限制

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

使用说明

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

资源复制场景

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

资源探查场景

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

资源纳管场景

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

资源迁移场景

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

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

调试

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

授权信息

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

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

请求参数

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

资源场景所属的地域 ID。

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

cn-hangzhou
TemplateScratchTypestring是

资源场景类型，取值：

  • ArchitectureReplication：资源复制。

  • ArchitectureDetection：资源探查。

  • ResourceImport：资源纳管。

  • ResourceMigration：资源迁移。

说明 当 TemplateScratchType 参数取值不同时，请求参数补充说明中可选的参数属性也不同。 更多信息，请参见下方的请求参数补充说明。
ArchitectureReplication
Descriptionstring否

资源场景说明。

复制VPC资源。
SourceResourcesobject []否

源资源。

如果 TemplateScratchType 为 ArchitectureDetection，设置本参数意味着探查出以指定的源资源为起点的所有资源的架构数据。例如，指定 CLB 实例 ID，会探查出其所关联的 ECS 实例、vSwitch、VPC 等资源架构数据。

最多支持设置 200 个源资源。如果 TemplateScratchType 为 ArchitectureDetection，最多设置 20 个源资源。

ResourceIdstring是

资源 ID。

vpc-bp1m6fww66xbntjyc****
ResourceTypestring是

资源类型。

ALIYUN::ECS::VPC
RegionIdstring否

资源所属的地域 ID。

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

说明
  • 仅在 TemplateScratchType 为 ArchitectureDetection 时生效。
  • 全局资源的地域为global。例如，ALIYUN::CDN::Domain 是全局资源，资源所属的地域 ID 为global。
    •
    		cn-beijing
    SourceTagobject否

    源标签。

    ResourceTagsobject是

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

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

    		{"a": "b"}
    ResourceTypeFilterarray否

    资源类型筛选器。

    string否

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

    最多支持 20 个资源类型。

    		ALIYUN::ECS::VPC
    SourceResourceGroupobject否

    源资源组。

    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
    Tagsobject []否

    资源场景的标签。

    Keystring是

    资源场景的标签键。

    说明 Tags 为可选参数。如果需要指定 Tags，则 Tags.N.Key 必须指定。
    		usage
    Valuestring否

    资源场景的标签值。

    		test
    ResourceGroupIdstring否

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

    		rg-acfmxazb4ph6aiy****

    请求参数补充说明

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

    当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 实例数据。

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    		84980977-22F0-5421-B30D-B201311D5DCF
    TemplateScratchIdstring

    资源场景 ID。

    		ts-7f7a704cf71c49a6****

    示例

    正常返回示例

    JSON格式

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

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2024-04-24API 内部配置变更，不影响调用看变更集
    变更项变更内容
    API 内部配置变更，不影响调用。
    2023-10-19API 内部配置变更，不影响调用看变更集
    变更项变更内容
    API 内部配置变更，不影响调用。
    2023-10-10OpenAPI 入参发生变更看变更集
    变更项变更内容
    入参OpenAPI 入参发生变更。
      新增入参：ResourceGroupId
    文档推荐
    • 本页导读 （1）
    文档反馈