- AI任务相关接口
- 资源栈相关接口
- 资源相关接口
- 资源场景相关接口
- 模板相关接口
- 资源栈策略相关接口
- 更改集相关接口
- 资源栈组相关接口
- 偏差检测相关接口
- 标签相关接口
- 诊断相关接口
- 资源类型相关接口
- 其他相关接口
接口说明
使用限制
仅部分资源类型支持资源场景功能。更多信息,请参见支持资源场景的资源类型。
使用说明
通过资源场景功能,您可以在可视化界面上选择资源范围,并对一组资源进行复制、纳管等操作,从而简化资源管理。关于资源场景的更多信息,请参见概览。
资源复制场景
如果您需要复制一组资源及其依赖关系,可以通过创建资源复制场景复制指定范围内的所有资源,生成一套架构完全相同的资源。更多信息,请参见资源复制场景。
资源探查场景
如果您当前创建的资源之间关系错综复杂,您可以通过创建资源探查场景预览整体资源架构,或者以特定资源为起点的资源架构,从而方便管理资源。更多信息,请参见资源探查场景。
资源纳管场景
如果您需要将一组现有资源导入到一个新的资源栈中进行统一管理,可以创建资源纳管类型的资源场景。更多信息,请参见资源纳管场景。
资源迁移场景
如果您需要迁移一组资源及其依赖关系,可以创建资源迁移类型的资源场景,在资源场景中迁移资源、生成资源栈,通过资源栈查看迁移进度,待迁移完成后,您还可以删除源资源。更多信息,请参见资源迁移场景。
本文将提供一个示例,为您在杭州地域创建一个资源复制类型的资源场景,用于复制专有网络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 如下:
ParameterKey | ParameterValue |
---|---|
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。取值:
|
InstancePeriod | 希望复制的 ECS 预付费实例的付费时长,默认同源实例。 |
InstancePeriodUnit | 希望复制的 ECS 预付费实例的付费周期,默认同源实例。取值:
|
InstanceAmount | 希望复制的 ECS 实例数量,仅在源资源为单个 ECS 实例时生效。 |
RamAttachedPolicyReplication | 是否复制关联的 RAM 策略,默认 false。取值:
|
SlbListenerProtocols | 传统型负载均衡实例监听协议,用来限定复制的监听协议,可设置一个或多个,使用英文逗号分隔,默认为不限定。取值:
|
资源探查场景
当 ArchitectureReplication 参数取值为 ArchitectureDetection 时,资源探查类型的资源场景支持的 ParameterKey、ParameterValue 如下:
ParameterKey | ParameterValue |
---|---|
RegionIds | 一个或多个地域,使用","分隔。支持全局地域global 。如果不指定,则为当前资源场景的地域。 |
资源纳管场景
当 ArchitectureDetection 参数取值为 ResourceImport 时,资源纳管类型的资源场景支持的 ParameterKey、ParameterValue 如下:
ParameterKey | ParameterValue |
---|---|
DeletionPolicy | 资源删除策略,取值: Retain:保留。将资源纳管至资源栈后,在删除此资源栈时,保留原有资源。 Delete:删除。将资源纳管至资源栈后,在删除此资源栈时,默认删除原有资源;若在删除确认框中选择保留部分资源,则删除未选择保留的资源。 |
SlbListenerProtocols | 传统型负载均衡实例监听协议,用来限定纳管的监听协议,可设置一个或多个,使用英文逗号分隔,默认为不限定。取值:
|
资源迁移场景
当 ArchitectureDetection 参数的取值为 ResourceMigration 时,资源迁移类型的资源场景支持的 ParameterKey、ParameterValue 如下:
ParameterKey | ParameterValue |
---|---|
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**** |