文档

CreateScalingConfiguration - 创建一个ECS类型伸缩配置

调用API CreateScalingConfiguration接口创建一个ECS类型的伸缩配置,方便弹性伸缩在触发弹性扩张活动时以该伸缩配置为模板自动创建ECS实例。

接口说明

伸缩配置用来指定弹性扩张时使用的 ECS 实例模板,支持以下实例配置方式:

  • InstancePatternInfos:智能配置模式,无需指定具体的实例规格,只需根据业务需求指定实例的 vCPU 核数、内存大小、规格族级别以及最高价格,系统会自动筛选符合要求的实例规格,并优先选择价格最低的实例规格创建 ECS 实例。该模式仅适用于伸缩组的网络类型为专有网络,能够有效降低扩容时实例规格库存不足的情况。

  • InstanceType:指定一种实例规格。

  • InstanceTypes:指定多种实例规格。

  • InstanceTypeOverrides:指定多种实例规格,并为不同的实例规格配置权重。

  • Cpu 和 Memory:指定 CPU 和内存定义实例规格的范围,弹性伸缩会结合 IO 优化、可用区等因素确定可用实例规格集合,并根据价格排序为您创建价格最低的实例。该方式仅适用于伸缩组的扩缩容策略为成本优化策略,且伸缩配置未指定实例规格的场景。

说明 InstanceType、InstanceTypes、InstanceTypeOverrides、Cpu 和 Memory 这四种方式不能同时指定,但 InstanceType 或者 InstanceTypes 可以与 InstancePatternInfos 同时指定。与 InstancePatternInfos 同时指定时,弹性伸缩优先使用您指定的实例规格扩容,当指定的实例规格无库存时,再使用符合 InstancePatternInfos 配置的实例规格。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
ScalingGroupIdstring

伸缩配置所属的伸缩组的 ID。

asg-bp14wlu85wrpchm0****
ImageIdstring

镜像文件 ID,自动创建实例时使用的镜像资源。

centos6u5_64_20G_aliaegis****.vhd
ImageNamestring

镜像文件名称,同一个地域内镜像名称唯一。如果设置了 ImageId,ImageName 将被忽略。

不支持通过 ImageName 设置镜像市场镜像。

image****
InstanceTypestring

ECS 实例的实例规格,更多信息,请参见实例规格族。

ecs.g6.large
Cpuinteger

vCPU 个数。单位:核。

同时指定 CPU 和 Memory 可以定义实例规格范围,例如,CPU=2 且 Memory=16 可以定义配置为 2 vCPU 和 16 GiB 的所有实例规格。弹性伸缩会结合 IO 优化、可用区等因素确定可用实例规格集合,并根据价格排序为您创建价格最低的实例。

说明 该区间配置效果仅在成本优化模式下且伸缩配置未设置实例规格时生效。
2
Memoryinteger

内存大小。单位:GiB。

同时指定 CPU 和 Memory 可以定义实例规格范围。例如,CPU=2 且 Memory=16 可以定义配置为 2 vCPU 和 16 GiB 的所有实例规格。弹性伸缩会结合 IO 优化、可用区等因素确定可用实例规格集合,并根据价格排序为您创建价格最低的实例。

说明 该区间配置效果仅在成本优化模式下且伸缩配置未设置实例规格时生效。
16
DeploymentSetIdstring

ECS 实例所属的部署集的 ID。

ds-bp1frxuzdg87zh4pz****
SecurityGroupIdstring

ECS 实例所属的安全组的 ID,同一个安全组内的 ECS 实例可以互相访问。

sg-280ih****
IoOptimizedstring

是否为 I/O 优化实例。取值范围:

none:非 I/O 优化实例。 optimized:I/O 优化实例。

已停售的实例规格的实例默认值是 none,其他实例规格的实例默认值是 optimized。

optimized
InternetChargeTypestring

网络计费类型。取值范围:

  • PayByBandwidth:按带宽计费。此时 InternetMaxBandwidthOut 即为所选的固定带宽值。

  • PayByTraffic:按流量计费。此时 InternetMaxBandwidthOut 只是一个带宽上限,计费以实际产生的网络流量为依据。

如果未指定该参数,经典网络下默认值为 PayByBandwidth,专有网络 VPC 下默认值为 PayByTraffic。

PayByTraffic
InternetMaxBandwidthIninteger

公网入带宽最大值,单位为 Mbps(Mega bit per second),取值范围:1~200。

如果您没有指定该参数,则入带宽将自动被设置为 200 Mbps。实例的入数据流量免费,该参数在任何情况下都不涉及计费。

100
InternetMaxBandwidthOutinteger

公网出带宽最大值,单位为 Mbps(Mega bit per second)。取值范围:

  • 按带宽计费:0~1024,如果您没有指定该参数,则出带宽将自动被设置为 0 Mbps。

  • 按流量计费:0~1024,如果您没有指定该参数,则会出现报错。

50
SystemDisk.Categorystring

系统盘的磁盘种类。取值范围:

  • cloud:普通云盘。

  • cloud_efficiency:高效云盘。

  • cloud_ssd:SSD 云盘。

  • ephemeral_ssd:本地 SSD 盘。

  • cloud_essd:ESSD 云盘。

  • cloud_auto:ESSD AutoPL 云盘。

该参数不能与SystemDiskCategories同时指定。当该参数与SystemDiskCategories都未指定时,该参数有默认值:

  • 对于 I/O 优化实例,默认值为 cloud_efficiency。
  • 对于非 I/O 优化实例,默认值为 cloud。
cloud_ssd
SystemDisk.Sizeinteger

系统盘的大小,单位:GiB。取值范围:

  • cloud:20~500。
  • cloud_efficiency:20~500。
  • cloud_ssd:20~500。
  • cloud_essd:20~500。
  • ephemeral_ssd:20~500。

指定该参数后,系统盘大小必须大于等于 max{20, ImageSize}。

默认值:max{40, ImageSize}。

100
SystemDisk.DiskNamestring

系统盘名称。长度为 2~128 个英文或中文字符。必须以大小字母或中文开头,不能以http://https://开头。可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。

cloud_ssdSystem
SystemDisk.Descriptionstring

系统盘的描述。长度为 2~256 个英文或中文字符,不能以http://https://开头。

Test system disk.
SystemDisk.AutoSnapshotPolicyIdstring

系统盘使用的自动快照策略 ID。

sp-bp12m37ccmxvbmi5****
SystemDisk.PerformanceLevelstring

当系统盘为 ESSD 云盘时,设置云盘的性能等级。取值范围:

  • PL0:单盘最高随机读写 IOPS 1 万。

  • PL1:单盘最高随机读写 IOPS 5 万。

  • PL2:单盘最高随机读写 IOPS 10 万。

  • PL3:单盘最高随机读写 IOPS 100 万。

默认值:PL1。

PL0
ScalingConfigurationNamestring

伸缩配置的名称,2~64 英文或中文字符,以数字、大小写字母或中文开头,可包含数字、下划线(_)、短划线(-)或半角句号(.)。

在同一地域下同一伸缩组内伸缩配置名称唯一。如果您没有指定该参数,则默认使用伸缩配置的 ID。

scalingconfig****
LoadBalancerWeightinteger

ECS 实例作为负载均衡后端服务器时的权重,取值范围:1~100。

默认值:50。

50
Tagsstring

ECS 实例的标签。标签以键值对方式传入,最多可以使用 20 组标签。Key 和 Value 的使用要求如下:

  • Key 最多支持 64 个字符,不能以 aliyun 和 acs:开头,不能包含http://或者https://。一旦使用标签,Key 不允许为空字符串。
  • Value 最多支持 128 个字符,不能以 aliyun 和 acs:开头,不能包含http://或者https://。Value 可以为空字符串。
{"key1":"value1","key2":"value2", ... "key5":"value5"}
UserDatastring

ECS 实例的自定义数据,需要以 Base64 方式编码,编码前的原始数据最多为 16 KB。

echo hello ecs!
KeyPairNamestring

登录 ECS 实例时使用的密钥对的名称。

  • 对 Windows 实例,该参数将被忽略,默认为空。
  • 对 Linux 实例,密码登录方式会被初始化成禁止。
KeyPairTest
RamRoleNamestring

ECS 实例的 RAM 角色名称。RAM 角色名称由 RAM 提供和维护,您可调用 ListRoles 查询可用的 RAM 角色。

ramrole****
SecurityEnhancementStrategystring

是否开启安全加固。取值范围:

  • Active:启用安全加固,只对公共镜像生效。
  • Deactive:不启用安全加固,对所有镜像类型生效。
Active
InstanceNamestring

使用本伸缩配置自动创建的 ECS 实例的名称。

instance****
HostNamestring

云服务器的主机名。半角句号(.)或短划线(-)不能作为首尾字符,不能连续使用半角句号(.)或短划线(-)。另外,不同类型实例的命名要求如下:

  • Windows 实例:主机名长度为 2~15,可以包含大小写字母、数字和短划线(-)。不能包含半角句号(.),不能全是数字。
  • 其他类型实例(Linux 等):主机名长度为 2~64,可以包含多个半角句号(.)。两个半角句号(.)之间为一段,每段可以包含大小写字母、数字和短划线(-)。
host****
SpotStrategystring

后付费实例的抢占策略。取值范围:

  • NoSpot:普通的按量付费实例。
  • SpotWithPriceLimit:设置上限价格的抢占式实例。
  • SpotAsPriceGo:系统自动出价,跟随当前市场实际价格。

默认值:NoSpot。

NoSpot
PasswordInheritboolean

是否使用镜像预设的密码。使用该参数时,您需要确保使用的镜像已经设置了密码。取值范围:

  • true:使用镜像预设密码。
  • false:不使用镜像预设密码。
false
Passwordstring

ECS 实例的密码。长度为 8 至 30 个字符,必须同时包含大小写英文字母、数字和特殊符号中的三类字符。特殊符号可以是:

`() ~!@#$%^&*-_+=\|{}[]:;'<>,.?/

其中,Windows 实例不能以斜线号(/)为密码首字符。

说明 如果传入 Password 参数,建议您使用 HTTPS 协议发送请求,避免密码泄露。
123abc****
ResourceGroupIdstring

ECS 实例所属资源组的 ID。

rg-resource****
HpcClusterIdstring

ECS 实例所属的 HPC 集群的 ID。

hpc-clusterid
InstanceDescriptionstring

ECS 实例的描述。长度为 2~256 个英文或中文字符,不能以http://https://开头。

Test instance.
ClientTokenstring

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性

123e4567-e89b-12d3-a456-42665544****
Ipv6AddressCountinteger

为弹性网卡指定随机生成的 IPv6 地址数量。

1
CreditSpecificationstring

指定突发性能实例的运行模式。取值范围:

  • Standard:标准模式。

  • Unlimited:无性能约束模式。

更多信息,请参见突发性能实例概述下的性能模式章节。

Standard
ImageFamilystring

镜像族系名称,通过设置该参数来获取当前镜像族系内最新的可用镜像,用于创建实例。如果已经设置了参数ImageId,则不能设置该参数。

hangzhou-daily-update
ZoneIdstring

ECS 实例所属的可用区 ID。

cn-hangzhou-g
DedicatedHostIdstring

是否在专有宿主机上创建 ECS 实例。由于专有宿主机不支持创建抢占式实例,指定 DedicatedHostId 参数后,会自动忽略请求中的 SpotStrategy 和 SpotPriceLimit 设置。

您可以调用 DescribeDedicatedHosts 接口查询专有宿主机 ID 列表。

dh-bp67acfmxazb4p****
Affinitystring

专有宿主机实例是否与专有宿主机关联。取值范围:

  • default:实例不与专有宿主机关联。已启用节省停机模式的实例,停机后再次启动时,若原专有宿主机可用资源不足,则实例被放置在自动部署资源池的其它专有宿主机上。

  • host:实例与专有宿主机关联。已启用节省停机模式的实例,停机后再次启动时,仍放置在原专有宿主机上。若原专有宿主机可用资源不足,则实例重启失败。

默认值:default。

default
Tenancystring

是否在专有宿主机上创建实例。取值范围:

  • default:创建非专有宿主机实例。

  • host:创建专有宿主机实例。若您不指定 DedicatedHostId,则由阿里云自动选择专有宿主机放置实例。

默认值:default。

default
SchedulerOptionsobject

调度选项。

["testManagedPrivateSpaceId****"]
PrivatePoolOptions.MatchCriteriastring

实例启动的私有池容量选项。弹性保障服务或容量预定服务在生效后会生成私有池容量,供实例启动时选择。取值范围:

  • Open:开放模式。将自动匹配开放类型的私有池容量。如果没有符合条件的私有池容量,则使用公共池资源启动。该模式下无需设置 PrivatePoolOptions.Id 参数。

  • Target:指定模式。使用指定的私有池容量启动实例,如果该私有池容量不可用,则实例会启动失败。该模式下必须指定私有池 ID,即 PrivatePoolOptions.Id 参数为必填项。

  • None:不使用模式。实例启动将不使用私有池容量。

Open
PrivatePoolOptions.Idstring

私有池 ID。即弹性保障服务 ID 或容量预定服务 ID。

eap-bp67acfmxazb4****
SpotDurationinteger

抢占式实例的保留时长,单位为小时。取值范围:

  • 1:创建后阿里云会保证实例运行 1 小时不会被自动释放;超过 1 小时后,系统会自动比较出价与市场价格、检查资源库存,来决定实例的保留或回收。
  • 0:创建后,阿里云不能保证实例运行 1 小时,系统会自动比较出价与市场价格、检查资源库存,来决定实例的保留或回收。
说明 实例被回收前 5 分钟内,阿里云会通过 ECS 系统事件向您发送通知。抢占式实例按秒计费,建议您结合具体任务执行耗时来选择合适的保留时长。

默认值:1。

1
SpotInterruptionBehaviorstring

抢占实例中断模式。目前仅支持 terminate(默认)直接释放实例。

Terminate
InstanceTypesarray

多实例规格参数。如果使用了 InstanceTypes,InstanceType 将被忽略。

当无法根据优先级较高的实例规格创建出实例时,弹性伸缩服务会自动选择下一优先级的实例规格来创建实例。

string

多实例规格参数。如果使用了 InstanceTypes,InstanceType 将被忽略。

当无法根据优先级较高的实例规格创建出实例时,弹性伸缩服务会自动选择下一优先级的实例规格来创建实例。

ecs.g6.large
InstanceTypeOverridesobject []

用于指定的实例规格相关信息。

InstanceTypestring

当您需要伸缩组按照实例规格容量进行伸缩时,请同时指定本参数和 WeightedCapacity。

本参数用于指定实例规格,会覆盖启动模板中的实例规格。您可以指定 N 个本参数,扩展启动模板支持 N 个实例规格。N 的取值范围:1~10。

说明 仅当 LaunchTemplateId 参数指定了启动模板时,本参数生效。

InstanceType 的取值范围:在售的 ECS 实例规格。

ecs.c5.xlarge
WeightedCapacityinteger

当您需要指定伸缩配置中实例规格的容量时,在指定 InstanceTypeOverrides.InstanceType 后,再指定本参数。

本参数用于指定实例规格的权重,即实例规格的单台实例在伸缩组中表示的容量大小。权重越大,满足期望容量所需的本实例规格的实例数量越少。

由于每个实例规格的 vCPU 个数、内存大小等性能指标会有差异,您可以根据自身需求,给不同的实例规格配置不同的权重。

例如:

  • 当前容量:0。
  • 期望容量:6。
  • ecs.c5.xlarge 规格容量:4。

为满足期望容量,伸缩组将为用户扩容 2 台 ecs.c5.xlarge 实例。

说明 扩容时伸缩组的容量不得超过最大容量(MaxSize)与实例规格的最大权重之和。

WeightedCapacity 的取值范围:1~500。

4
DataDisksobject []

数据盘信息的集合。

PerformanceLevelstring

当数据盘为 ESSD 云盘时,设置云盘的性能等级。取值范围:

  • PL0:单盘最高随机读写 IOPS 1 万。
  • PL1:单盘最高随机读写 IOPS 5 万。
  • PL2:单盘最高随机读写 IOPS 10 万。
  • PL3:单盘最高随机读写 IOPS 100 万。
说明 关于如何选择 ESSD 云盘性能等级,请参见 ESSD 云盘
PL0
AutoSnapshotPolicyIdstring

数据盘使用的自动快照策略 ID。

sp-bp19nq9enxqkomib****
Encryptedstring

数据盘是否加密。该参数取值范围:

  • true:加密。
  • false:不加密。

默认值:false。

false
Descriptionstring

数据盘的描述。长度为 2~256 个英文或中文字符,不能以http://https://开头。

Test data disk.
SnapshotIdstring

创建数据盘时使用的快照。指定该参数后,DataDisks.Size 会被忽略,实际创建的磁盘大小为指定快照的大小。

如果该快照创建于 2013 年 7 月 15 日或之前,调用会被拒绝,返回参数中会提示 InvalidSnapshot.TooOld。

s-280s7****
Categoriesarray

数据盘的多磁盘类型。当无法使用高优先级的磁盘类型时,弹性伸缩自动尝试下一优先级的磁盘类型创建数据盘。取值范围:

  • cloud:普通云盘。随实例创建的普通云盘的 DeleteWithInstance 属性为 true。
  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD 云盘。
  • cloud_essd:ESSD 云盘。
说明 指定本参数时,不允许同时指定DataDisks.Category
string

数据盘的多磁盘类型。当无法使用高优先级的磁盘类型时,弹性伸缩自动尝试下一优先级的磁盘类型创建数据盘。取值范围:

  • cloud:普通云盘。随实例创建的普通云盘的 DeleteWithInstance 属性为 true。
  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD 云盘。
  • cloud_essd:ESSD 云盘。
说明 指定本参数时,不允许同时指定DataDisks.Category
cloud
Sizeinteger

数据盘的磁盘大小,内存单位为 GiB。取值范围:

  • cloud:5~2000。
  • cloud_efficiency:20~32768。
  • cloud_essd:20~32768。
  • ephemeral_ssd:5~800。

指定该参数后,磁盘大小必须大于等于快照大小(快照通过 SnapshotId 指定)。

100
Devicestring

数据盘挂载点。如果您没有指定该参数,则默认在自动创建 ECS 实例时由系统分配,从/dev/xvdb 开始,到/dev/xvdz 结束。

/dev/xvdb
DiskNamestring

系统盘的名称。长度为 2~128 个英文或中文字符。必须以大小字母或中文开头,不能以http://https://开头。可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。

cloud_ssdData
Categorystring

数据盘的磁盘种类。取值范围:

  • cloud:普通云盘。
  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD 云盘。
  • cloud_essd:ESSD 云盘。
  • ephemeral_ssd:本地 SSD 盘。
  • cloud_auto:ESSD AutoPL 云盘。

该参数不能与 DataDisk.Categories 同时指定。当该参数与 DataDisk.Categories 都未指定时,该参数默认值:

  • 对于 I/O 优化实例,默认值为 cloud_efficiency。
  • 对于非 I/O 优化实例,默认值为 cloud。
cloud_ssd
DeleteWithInstanceboolean

指定数据盘是否随实例释放。该参数取值范围:

  • true:释放实例时,该磁盘随实例一起释放。
  • false:释放实例时,该磁盘保留不释放。

该参数只可对独立云盘设置(DataDisks.Category 为 cloud、cloud_efficiency、cloud_ssd 或 cloud_essd),否则会出现报错。

默认值:true。

true
KMSKeyIdstring

数据盘对应的 KMS 密钥的 ID。

0e478b7a-4262-4802-b8cb-00d3fb40****
ProvisionedIopslong

数据盘预配置的 IOPS(Input/Output Operations Per Second)性能指标。

说明 IOPS(Input/Output Operations Per Second)指每秒能处理的 I/O 个数,表示块存储处理读写(输出/输入)的能力,单位为次。
100
BurstingEnabledboolean

系统盘是否开启 Burst(性能突发)。取值范围:

  • true:开启。
  • false:未开启。
说明 SystemDisk.Category取值为cloud_auto时才支持设置该参数。

更多信息,请参见ESSD AutoPL 云盘

false
SpotPriceLimitsobject []

抢占式实例相关的计费信息组成的集合。

PriceLimitfloat

抢占式实例对应的出价。SpotStrategy 取值为 SpotWithPriceLimit 时生效。

0.5
InstanceTypestring

抢占式实例的实例规格。SpotStrategy 取值为 SpotWithPriceLimit 时生效。

ecs.g6.large
SecurityGroupIdsarray

将 ECS 实例同时加入多个安全组。更多详情,请参见使用限制下的安全组章节。

说明 不支持同时指定 SecurityGroupId 和 SecurityGroupIds。
string

将 ECS 实例同时加入多个安全组。更多详情,请参见使用限制下的安全组章节。

说明 不支持同时指定 SecurityGroupId 和 SecurityGroupIds。
sg-bp18kz60mefs****
InstancePatternInfosobject []

智能配置的信息集合,用于筛选符合要求的实例规格范围。

Coresinteger

智能配置模式下,实例规格的 vCPU 内核数目,用于筛选符合要求的实例规格范围。更多信息,请参见实例规格族

请注意以下信息:

  • InstancePatternInfos 参数仅适用于伸缩组的网络类型为专有网络。

  • InstancePatternInfos 参数必须同时配置 InstancePatternInfos.Cores 和 InstancePatternInfos.Memory。

  • 如果您已经通过 InstanceType 或 InstanceTypes 参数指定了实例规格,弹性伸缩优先使用您指定的实例规格扩容,当指定的实例规格无库存时,再从符合 InstancePatternInfos 参数值的实例规格中优先使用价格最低的实例规格扩容。

2
InstanceFamilyLevelstring

实例规格族级别,用于筛选符合要求的实例规格范围,当CostOptimization开启时生效。取值范围:

  • EntryLevel:入门级,即共享型实例规格。成本更低,但是无法保证实例计算性能的稳定。适用于平时 CPU 使用率低的业务场景。更多信息,请参见共享型
  • EnterpriseLevel:企业级。性能稳定且资源独享,适用于对稳定性要求高的业务场景。更多信息,请参见实例规格族
  • CreditEntryLevel:积分入门级,即突发性能实例。通过 CPU 积分来保证计算性能,适用于平时 CPU 使用率低、偶有突发 CPU 使用率的业务场景。更多信息,请参见突发性能实例概述
EnterpriseLevel
MaxPricefloat

智能配置模式下,按量付费实例或者抢占式实例可接受的每小时最高价格,用于筛选符合要求的实例规格范围。

说明 SpotStrategy 设置为 SpotWithPriceLimit 时,该参数必选。其他情况下,该参数可选。
2
Memoryfloat

智能配置模式下,实例规格的内存大小,单位为 GiB,用于筛选符合要求的实例规格范围。

4
ExcludedInstanceTypesarray

需要排除的实例规格。通过使用通配符(*)可以排除单个规格或者整个规格族。例如:

  • ecs.c6.large:表示排除 ecs.c6.large 实例规格。
  • ecs.c6.*:表示排除整个 c6 规格族的实例规格。
string

需要排除的实例规格。通过使用通配符(*)可以排除单个规格或者整个规格族。例如:

  • ecs.c6.large:表示排除 ecs.c6.large 实例规格。
  • ecs.c6.*:表示排除整个 c6 规格族的实例规格。
ecs.n1.small/ecs.n1.*/*7*
Architecturesarray

实例规格所属的架构类型。取值范围:

  • X86:X86 计算。
  • Heterogeneous:异构计算,例如 GPU 或 FPGA 等。
  • BareMental:弹性裸金属服务器。
  • Arm:Arm 计算。
  • SuperComputeCluster:超级计算集群。

默认值:包含所有架构类型。

string

实例规格所属的架构类型。取值范围:

  • X86:X86 计算。
  • Heterogeneous:异构计算,例如 GPU 或 FPGA 等。
  • BareMental:弹性裸金属服务器。
  • Arm:Arm 计算。
  • SuperComputeCluster:超级计算集群。

默认值:包含所有架构类型。

X86
BurstablePerformancestring

是否为性能突发实例规格。取值范围:

  • Exclude:不包含性能突发实例规格。
  • Include:包含性能突发实例规格。
  • Required:只包含性能突发实例规格。

默认值:Include。

Include
SystemDiskCategoriesarray

系统盘的多磁盘类型。当无法使用高优先级的磁盘类型时,弹性伸缩自动尝试下一优先级的磁盘类型创建系统盘。取值范围:

  • cloud:普通云盘。
  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD 云盘。
  • cloud_essd:ESSD 云盘。
说明 指定本参数时,不允许同时指定SystemDisk.Category
string

系统盘的多磁盘类型。当无法使用高优先级的磁盘类型时,弹性伸缩自动尝试下一优先级的磁盘类型创建系统盘。取值范围:

  • cloud:普通云盘。
  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD 云盘。
  • cloud_essd:ESSD 云盘。
说明 指定本参数时,不允许同时指定SystemDisk.Category
cloud
SystemDisk.Encryptedboolean

是否加密系统盘。取值范围:

  • true:加密。
  • false:不加密。

默认值:false。

false
SystemDisk.KMSKeyIdstring

系统盘使用的 KMS 密钥 ID。

0e478b7a-4262-4802-b8cb-00d3fb40****
SystemDisk.EncryptAlgorithmstring

系统盘采用的加密算法。取值范围:

  • AES-256。
  • SM4-128。

默认值:AES-256。

AES-256
SystemDisk.ProvisionedIopslong

系统盘预配置的 IOPS(Input/Output Operations Per Second)性能指标。

说明 IOPS(Input/Output Operations Per Second)指每秒能处理的 I/O 个数,表示块存储处理读写(输出/输入)的能力,单位为次。
100
SystemDisk.BurstingEnabledboolean

系统盘是否开启 Burst(性能突发)。取值范围:

  • true:开启。
  • false:未开启。
说明 SystemDisk.Category取值为cloud_auto时才支持设置该参数。

更多信息,请参见ESSD AutoPL 云盘

false
ImageOptions.LoginAsNonRootboolean

ECS 实例是否使用 ecs-user 用户登录,更多信息,请参见管理 ECS 实例的登录名。取值范围:

  • true:是。

  • false:否。

默认值:false。

false
DeletionProtectionboolean

实例释放保护属性,指定是否支持通过 ECS 控制台或 API(DeleteInstance)直接释放实例,防止实例被误删除。取值范围:

  • true:开启实例释放保护,无法通过 ECS 控制台或 API(DeleteInstance)直接释放实例。

  • false:关闭实例释放保护,可以通过 ECS 控制台或 API(DeleteInstance)直接释放实例。

默认值:false。

说明 该属性仅适用于按量付费实例,防止弹性伸缩扩容的实例被误删除,不影响正常的缩容活动,开启实例释放保护的实例可以被缩容活动释放掉。
false
StorageSetIdstring

存储集 ID。

ss-bp67acfmxazb4p****
StorageSetPartitionNumberinteger

存储集中的最大分区数量。取值范围:大于等于 2。

2
CustomPrioritiesobject []

ECS 实例规格+交换机的自定义优先级。

注意 仅在伸缩组的扩缩容策略为优先级策略时有效。

当无法根据优先级较高的实例规格+交换机创建出实例时,弹性伸缩服务会自动选择下一优先级的实例规格+交换机组合来创建实例。

说明 如果仅指定了部分实例规格+交换机的自定义优先级,则未指定的部分优先级低于指定的部分,且未指定部分仍会依次按照伸缩组的交换机顺序、伸缩配置的实例规格顺序确定优先级。
  • 例如:伸缩组的交换机顺序为 vsw1、vsw2,伸缩配置的实例规格顺序为 type1、type2,自定义优先级顺序为["vsw2+type2", "vsw1+type2"],则最终优先级为:"vsw2+type2" > "vsw1+type2" > "vsw1+type1" > "vsw2+type1"
  • InstanceTypestring

    ECS 实例的实例规格。

    注意 必须包含在伸缩配置的实例规格列表中。

    ecs.g6.large
    VswitchIdstring

    虚拟交换机的 ID。

    注意 必须包含在伸缩组的交换机列表中。

    vsw-bp14zolna43z266bq****

    返回参数

    名称类型描述示例值
    object

    创建伸缩配置相关信息。

    ScalingConfigurationIdstring

    伸缩配置 ID。

    asc-bp1ffogfdauy0nu5****
    RequestIdstring

    请求 ID。

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

    示例

    正常返回示例

    JSON格式

    {
      "ScalingConfigurationId": "asc-bp1ffogfdauy0nu5****",
      "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2024-01-29OpenAPI 入参发生变更看变更集
    变更项变更内容
    入参OpenAPI 入参发生变更
      新增入参:CustomPriorities
    2023-11-24OpenAPI 入参发生变更看变更集
    变更项变更内容
    入参OpenAPI 入参发生变更
      新增入参:StorageSetId
      新增入参:StorageSetPartitionNumber
    2023-08-23OpenAPI 入参发生变更看变更集
    变更项变更内容
    入参OpenAPI 入参发生变更
      新增入参:DeletionProtection
    2023-04-12OpenAPI 入参发生变更看变更集
    变更项变更内容
    入参OpenAPI 入参发生变更
      新增入参:ImageOptions.LoginAsNonRoot
    • 本页导读 (1)
    文档反馈