创建一个伸缩配置。
接口说明
伸缩配置用来指定弹性扩张时使用的ECS实例模板,支持以下实例配置方式:
InstancePatternInfos:智能配置模式,无需指定具体的实例规格,只需根据业务需求指定实例的vCPU核数、内存大小、规格族级别以及最高价格,系统会自动筛选符合要求的实例规格,并优先选择价格最低的实例规格创建ECS实例。该模式仅适用于伸缩组的网络类型为专有网络,能够有效降低扩容时实例规格库存不足的情况。
InstanceType:指定一种实例规格。
InstanceTypes:指定多种实例规格。
InstanceTypeOverrides:指定多种实例规格,并为不同的实例规格配置权重。
Cpu和Memory:指定CPU和内存定义实例规格的范围,弹性伸缩会结合IO优化、可用区等因素确定可用实例规格集合,并根据价格排序为您创建价格最低的实例。该方式仅适用于伸缩组的扩缩容策略为成本优化策略,且伸缩配置未指定实例规格的场景。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ScalingGroupId | string | 是 | 伸缩配置所属的伸缩组的ID。 | asg-bp14wlu85wrpchm0**** |
ImageId | string | 否 | 镜像文件ID,自动创建实例时使用的镜像资源。 | centos6u5_64_20G_aliaegis****.vhd |
ImageName | string | 否 | 镜像文件名称,同一个地域内镜像名称唯一。如果设置了ImageId,ImageName将被忽略。 不支持通过ImageName设置镜像市场镜像。 | image**** |
InstanceType | string | 否 | ECS实例的实例规格,更多信息,请参见实例规格族。 | ecs.g6.large |
Cpu | integer | 否 | vCPU个数。单位:核。 同时指定CPU和Memory可以定义实例规格范围,例如,CPU=2且Memory=16可以定义配置为2 vCPU和16 GiB的所有实例规格。弹性伸缩会结合IO优化、可用区等因素确定可用实例规格集合,并根据价格排序为您创建价格最低的实例。 说明该区间配置效果仅在成本优化模式下且伸缩配置未设置实例规格时生效。 | 2 |
Memory | integer | 否 | 内存大小。单位:GiB。 同时指定CPU和Memory可以定义实例规格范围。例如,CPU=2且Memory=16可以定义配置为2 vCPU和16 GiB的所有实例规格。弹性伸缩会结合IO优化、可用区等因素确定可用实例规格集合,并根据价格排序为您创建价格最低的实例。 说明该区间配置效果仅在成本优化模式下且伸缩配置未设置实例规格时生效。 | 16 |
DeploymentSetId | string | 否 | ECS实例所属的部署集的ID。 | ds-bp1frxuzdg87zh4pz**** |
SecurityGroupId | string | 否 | ECS实例所属的安全组的ID,同一个安全组内的ECS实例可以互相访问。 | sg-280ih**** |
IoOptimized | string | 否 | 是否为I/O优化实例。取值范围: none:非I/O优化实例。 optimized:I/O优化实例。 已停售的实例规格的实例默认值是none,其他实例规格的实例默认值是optimized。 | optimized |
InternetChargeType | string | 否 | 网络计费类型。取值范围:
如果未指定该参数,经典网络下默认值为PayByBandwidth,专有网络VPC下默认值为PayByTraffic。 | PayByTraffic |
InternetMaxBandwidthIn | integer | 否 | 公网入带宽最大值,单位为Mbps(Mega bit per second),取值范围:1~200。 如果您没有指定该参数,则入带宽将自动被设置为200 Mbps。实例的入数据流量免费,该参数在任何情况下都不涉及计费。 | 100 |
InternetMaxBandwidthOut | integer | 否 | 公网出带宽最大值,单位为Mbps(Mega bit per second)。取值范围:
| 50 |
SystemDisk.Category | string | 否 | 系统盘的磁盘种类。取值范围:
该参数不能与
| cloud_ssd |
SystemDisk.Size | integer | 否 | 系统盘的大小,单位:GiB。取值范围:
指定该参数后,系统盘大小必须大于等于max{20, ImageSize}。 默认值:max{40, ImageSize}。 | 100 |
SystemDisk.DiskName | string | 否 | 系统盘名称。长度为2~128个英文或中文字符。必须以大小字母或中文开头,不能以 | cloud_ssdSystem |
SystemDisk.Description | string | 否 | 系统盘的描述。长度为2~256个英文或中文字符,不能以 | Test system disk. |
SystemDisk.AutoSnapshotPolicyId | string | 否 | 系统盘使用的自动快照策略ID。 | sp-bp12m37ccmxvbmi5**** |
SystemDisk.PerformanceLevel | string | 否 | 当系统盘为ESSD云盘时,设置云盘的性能等级。取值范围:
默认值:PL0。 | PL0 |
ScalingConfigurationName | string | 否 | 伸缩配置的名称,2~64英文或中文字符,以数字、大小写字母或中文开头,可包含数字、下划线(_)、短划线(-)或半角句号(.)。 在同一地域下同一伸缩组内伸缩配置名称唯一。如果您没有指定该参数,则默认使用伸缩配置的ID。 | scalingconfig**** |
LoadBalancerWeight | integer | 否 | ECS实例作为负载均衡后端服务器时的权重,取值范围:1~100。 默认值:50。 | 50 |
Tags | string | 否 | ECS实例的标签。标签以键值对方式传入,最多可以使用20组标签。Key和Value的使用要求如下:
| {"key1":"value1","key2":"value2", ... "key5":"value5"} |
UserData | string | 否 | ECS实例的自定义数据,需要以Base64方式编码,编码前的原始数据最多为16 KB。 | echo hello ecs! |
KeyPairName | string | 否 | 登录ECS实例时使用的密钥对的名称。
| KeyPairTest |
RamRoleName | string | 否 | ECS实例的RAM角色名称。RAM角色名称由RAM提供和维护,您可调用ListRoles查询可用的RAM角色。 | ramrole**** |
SecurityEnhancementStrategy | string | 否 | 是否开启安全加固。取值范围:
| Active |
InstanceName | string | 否 | 使用本伸缩配置自动创建的ECS实例的名称。 | instance**** |
HostName | string | 否 | 云服务器的主机名。半角句号(.)或短划线(-)不能作为首尾字符,不能连续使用半角句号(.)或短划线(-)。另外,不同类型实例的命名要求如下:
| host**** |
SpotStrategy | string | 否 | 后付费实例的抢占策略。取值范围:
默认值:NoSpot。 | NoSpot |
PasswordInherit | boolean | 否 | 是否使用镜像预设的密码。使用该参数时,您需要确保使用的镜像已经设置了密码。取值范围:
| false |
Password | string | 否 | ECS实例的密码。长度为8至30个字符,必须同时包含大小写英文字母、数字和特殊符号中的三类字符。特殊符号可以是: `() 其中,Windows实例不能以斜线号(/)为密码首字符。 说明如果传入Password参数,建议您使用HTTPS协议发送请求,避免密码泄露。 | 123abc**** |
ResourceGroupId | string | 否 | ECS实例所属资源组的ID。 | rg-resource**** |
HpcClusterId | string | 否 | ECS实例所属的HPC集群的ID。 | hpc-clusterid |
InstanceDescription | string | 否 | ECS实例的描述。长度为2~256个英文或中文字符,不能以 | Test instance. |
ClientToken | string | 否 | 保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。只支持ASCII字符,且不能超过64个字符。更多信息,请参见如何保证幂等性。 | 123e4567-e89b-12d3-a456-42665544**** |
Ipv6AddressCount | integer | 否 | 为弹性网卡指定随机生成的IPv6地址数量。 | 1 |
CreditSpecification | string | 否 | Standard | |
ImageFamily | string | 否 | 镜像族系名称,通过设置该参数来获取当前镜像族系内最新可用的自定义镜像,用于创建实例。如果已经设置了参数ImageId,则不能设置该参数。 | hangzhou-daily-update |
ZoneId | string | 否 | ECS实例所属的可用区ID。 | cn-hangzhou-g |
DedicatedHostId | string | 否 | 是否在专有宿主机上创建ECS实例。由于专有宿主机不支持创建抢占式实例,指定DedicatedHostId参数后,会自动忽略请求中的SpotStrategy和SpotPriceLimit设置。 您可以调用DescribeDedicatedHosts接口查询专有宿主机ID列表。 | dh-bp67acfmxazb4p**** |
Affinity | string | 否 | 专有宿主机实例是否与专有宿主机关联。取值范围:
默认值:default。 | default |
Tenancy | string | 否 | 是否在专有宿主机上创建实例。取值范围:
默认值:default。 | default |
SchedulerOptions | object | 否 | 调度选项。 | |
PrivatePoolOptions.MatchCriteria | string | 否 | 实例启动的私有池容量选项。弹性保障服务或容量预定服务在生效后会生成私有池容量,供实例启动时选择。取值范围:
| Open |
PrivatePoolOptions.Id | string | 否 | 私有池ID。即弹性保障服务ID或容量预定服务ID。 | eap-bp67acfmxazb4**** |
SpotDuration | integer | 否 | 抢占式实例的保留时长,单位为小时。取值范围:0~6。
默认值:1。 | 1 |
SpotInterruptionBehavior | string | 否 | 抢占实例中断模式。目前仅支持terminate(默认)直接释放实例。 | Terminate |
InstanceTypes | array | 否 | 多实例规格参数。如果使用了InstanceTypes,InstanceType将被忽略。 当无法根据优先级较高的实例规格创建出实例时,弹性伸缩服务会自动选择下一优先级的实例规格来创建实例。 | |
string | 否 | 多实例规格参数。如果使用了InstanceTypes,InstanceType将被忽略。 当无法根据优先级较高的实例规格创建出实例时,弹性伸缩服务会自动选择下一优先级的实例规格来创建实例。 | ecs.g6.large | |
InstanceTypeOverrides | array | 否 | 用于指定的实例规格相关信息。 | |
object | 否 | 用于指定的实例规格相关信息。 | ||
InstanceType | string | 否 | 当您需要伸缩组按照实例规格容量进行伸缩时,请同时指定本参数和WeightedCapacity。 本参数用于指定实例规格,会覆盖启动模板中的实例规格。您可以指定N个本参数,扩展启动模板支持N个实例规格。N的取值范围:1~10。 说明仅当LaunchTemplateId参数指定了启动模板时,本参数生效。 InstanceType的取值范围:在售的ECS实例规格。 | ecs.c5.xlarge |
WeightedCapacity | integer | 否 | 当您需要指定伸缩配置中实例规格的容量时,在指定InstanceTypeOverrides.InstanceType后,再指定本参数。 本参数用于指定实例规格的权重,即实例规格的单台实例在伸缩组中表示的容量大小。权重越大,满足期望容量所需的本实例规格的实例数量越少。 由于每个实例规格的vCPU个数、内存大小等性能指标会有差异,您可以根据自身需求,给不同的实例规格配置不同的权重。 例如:
为满足期望容量,伸缩组将为用户扩容2台ecs.c5.xlarge实例。 说明扩容时伸缩组的容量不得超过最大容量(MaxSize)与实例规格的最大权重之和。 WeightedCapacity的取值范围:1~500。 | 4 |
DataDisks | array | 否 | 数据盘信息的集合。 | |
object | 否 | 数据盘信息的集合。 | ||
PerformanceLevel | string | 否 | 当数据盘为ESSD云盘时,设置云盘的性能等级。取值范围:
说明关于如何选择ESSD云盘性能等级,请参见ESSD云盘。 | PL0 |
AutoSnapshotPolicyId | string | 否 | 数据盘使用的自动快照策略ID。 | sp-bp19nq9enxqkomib**** |
Encrypted | string | 否 | 数据盘是否加密。该参数取值范围:
默认值:false。 | false |
Description | string | 否 | 数据盘的描述。长度为2~256个英文或中文字符,不能以 | Test data disk. |
SnapshotId | string | 否 | 创建数据盘时使用的快照。指定该参数后,DataDisks.Size会被忽略,实际创建的磁盘大小为指定快照的大小。 如果该快照创建于2013年7月15日或之前,调用会被拒绝,返回参数中会提示InvalidSnapshot.TooOld。 | s-280s7**** |
Categories | array | 否 | 数据盘的多磁盘类型。当无法使用高优先级的磁盘类型时,弹性伸缩自动尝试下一优先级的磁盘类型创建数据盘。取值范围:
说明指定本参数时,不允许同时指定 DataDisks.Category 。 | |
string | 否 | 数据盘的多磁盘类型。当无法使用高优先级的磁盘类型时,弹性伸缩自动尝试下一优先级的磁盘类型创建数据盘。取值范围:
说明指定本参数时,不允许同时指定 DataDisks.Category 。 | cloud | |
Size | integer | 否 | 数据盘的磁盘大小,内存单位为GiB。取值范围:
指定该参数后,磁盘大小必须大于等于快照大小(快照通过SnapshotId指定)。 | 100 |
Device | string | 否 | 数据盘挂载点。如果您没有指定该参数,则默认在自动创建ECS实例时由系统分配,从/dev/xvdb开始,到/dev/xvdz结束。 | /dev/xvdb |
DiskName | string | 否 | 系统盘的名称。长度为2~128个英文或中文字符。必须以大小字母或中文开头,不能以 | cloud_ssdData |
Category | string | 否 | 数据盘的磁盘种类。取值范围:
该参数不能与DataDisk.Categories同时指定。当该参数与DataDisk.Categories都未指定时,该参数默认值:
| cloud_ssd |
DeleteWithInstance | boolean | 否 | 指定数据盘是否随实例释放。该参数取值范围:
该参数只可对独立云盘设置(DataDisks.Category为cloud、cloud_efficiency、cloud_ssd或cloud_essd),否则会出现报错。 默认值:true。 | true |
KMSKeyId | string | 否 | 数据盘对应的KMS密钥的ID。 | 0e478b7a-4262-4802-b8cb-00d3fb40**** |
ProvisionedIops | long | 否 | 数据盘预配置的IOPS(Input/Output Operations Per Second)性能指标。 说明IOPS(Input/Output Operations Per Second)指每秒能处理的I/O个数,表示块存储处理读写(输出/输入)的能力,单位为次。 | 100 |
BurstingEnabled | boolean | 否 | 系统盘是否开启Burst(性能突发)。取值范围:
说明当 SystemDisk.Category 取值为cloud_auto 时才支持设置该参数。更多信息,请参见ESSD AutoPL云盘。 | false |
SpotPriceLimits | array | 否 | 抢占式实例相关的计费信息组成的集合。 | |
object | 否 | 抢占式实例相关的计费信息组成的集合。 | ||
PriceLimit | float | 否 | 抢占式实例对应的出价。SpotStrategy取值为SpotWithPriceLimit时生效。 | 0.5 |
InstanceType | string | 否 | 抢占式实例的实例规格。SpotStrategy取值为SpotWithPriceLimit时生效。 | ecs.g6.large |
SecurityGroupIds | array | 否 | 将ECS实例同时加入多个安全组。更多详情,请参见使用限制下的安全组章节。 说明不支持同时指定SecurityGroupId和SecurityGroupIds。 | |
string | 否 | 将ECS实例同时加入多个安全组。更多详情,请参见使用限制下的安全组章节。 说明不支持同时指定SecurityGroupId和SecurityGroupIds。 | sg-bp18kz60mefs**** | |
InstancePatternInfos | array | 否 | 智能配置的信息集合,用于筛选符合要求的实例规格范围。 | |
object | 否 | 智能配置的信息集合,用于筛选符合要求的实例规格范围。 | ||
Cores | integer | 否 | 智能配置模式下,实例规格的vCPU内核数目,用于筛选符合要求的实例规格范围。更多信息,请参见实例规格族。 请注意以下信息:
| 2 |
InstanceFamilyLevel | string | 否 | EnterpriseLevel | |
MaxPrice | float | 否 | 智能配置模式下,按量付费实例或者抢占式实例可接受的每小时最高价格,用于筛选符合要求的实例规格范围。 说明SpotStrategy设置为SpotWithPriceLimit时,该参数必选。其他情况下,该参数可选。 | 2 |
Memory | float | 否 | 智能配置模式下,实例规格的内存大小,单位为GiB,用于筛选符合要求的实例规格范围。 | 4 |
ExcludedInstanceTypes | array | 否 | 需要排除的实例规格。通过使用通配符(*)可以排除单个规格或者整个规格族。例如:
| |
string | 否 | 需要排除的实例规格。通过使用通配符(*)可以排除单个规格或者整个规格族。例如:
| ecs.n1.small/ecs.n1.*/*7* | |
Architectures | array | 否 | 实例规格所属的架构类型。取值范围:
默认值:包含所有架构类型。 | |
string | 否 | 实例规格所属的架构类型。取值范围:
默认值:包含所有架构类型。 | X86 | |
BurstablePerformance | string | 否 | 是否为性能突发实例规格。取值范围:
默认值:Include。 | Include |
SystemDiskCategories | array | 否 | 系统盘的多磁盘类型。当无法使用高优先级的磁盘类型时,弹性伸缩自动尝试下一优先级的磁盘类型创建系统盘。取值范围:
说明指定本参数时,不允许同时指定 SystemDisk.Category 。 | |
string | 否 | 系统盘的多磁盘类型。当无法使用高优先级的磁盘类型时,弹性伸缩自动尝试下一优先级的磁盘类型创建系统盘。取值范围:
说明指定本参数时,不允许同时指定 SystemDisk.Category 。 | cloud | |
SystemDisk.Encrypted | boolean | 否 | 是否加密系统盘。取值范围:
默认值:false。 | false |
SystemDisk.KMSKeyId | string | 否 | 系统盘使用的KMS密钥ID。 | 0e478b7a-4262-4802-b8cb-00d3fb40**** |
SystemDisk.EncryptAlgorithm | string | 否 | 系统盘采用的加密算法。取值范围:
默认值:AES-256。 | AES-256 |
SystemDisk.ProvisionedIops | long | 否 | 系统盘预配置的IOPS(Input/Output Operations Per Second)性能指标。 说明IOPS(Input/Output Operations Per Second)指每秒能处理的I/O个数,表示块存储处理读写(输出/输入)的能力,单位为次。 | 100 |
SystemDisk.BurstingEnabled | boolean | 否 | 系统盘是否开启Burst(性能突发)。取值范围:
说明当 SystemDisk.Category 取值为cloud_auto 时才支持设置该参数。更多信息,请参见ESSD AutoPL云盘。 | false |
返回参数
示例
正常返回示例
JSON
格式
{
"ScalingConfigurationId": "asc-bp1ffogfdauy0nu5****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}
错误码
访问错误中心查看更多错误码。