文档

CreateScalingConfiguration

更新时间:

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

接口说明

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

  • InstancePatternInfo.N:智能配置模式,无需指定具体的实例规格,只需根据业务需求指定实例的vCPU核数、内存大小、规格族级别以及最高价格,系统会自动筛选符合要求的实例规格,并优先选择价格最低的实例规格创建ECS实例。该模式仅适用于伸缩组的网络类型为专有网络,能够有效降低扩容时实例规格库存不足的情况。
  • InstanceType:指定一种实例规格。
  • InstanceTypes.N:指定多种实例规格。
  • InstanceTypeOverride.N:指定多种实例规格,并为不同的实例规格配置权重。
  • Cpu和Memory:指定CPU和内存定义实例规格的范围,弹性伸缩会结合IO优化、可用区等因素确定可用实例规格集合,并根据价格排序为您创建价格最低的实例。该方式仅适用于伸缩组的扩缩容策略为成本优化策略,且伸缩配置未指定实例规格的场景。
  • 支持以下任一方式绑定主网卡。但需要注意每次调用接口时只能选用一种方式配置主网卡,两种方式同时使用时将会导致接口调用失败并返回错误信息。
    • 通过SecurityGroupIdSecurityGroupIds.NIpv6AddressCount等参数直接设置主网卡的相关配置信息。
    • 通过NetworkInterfaces.N设置主网卡以及辅助网卡的配置信息,使用该参数时必须设置主网卡信息。其中,NetworkInterfaces.N.InstanceType取值为Primary时,表示设置主网卡;当NetworkInterfaces.N.InstanceType取值为Secondary或空值时,表示设置辅助网卡。
说明 InstanceType、InstanceTypes.N、InstanceTypeOverride.N、Cpu和Memory这四种方式不能同时指定,但InstanceType或者InstanceTypes.N可以与InstancePatternInfo.N同时指定。与InstancePatternInfo.N同时指定时,弹性伸缩优先使用您指定的实例规格扩容,当指定的实例规格无库存时,再使用符合InstancePatternInfo.N配置的实例规格。

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String CreateScalingConfiguration

系统规定参数。取值:CreateScalingConfiguration

ScalingGroupId String asg-bp14wlu85wrpchm0****

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

ImageId String centos6u5_64_20G_aliaegis****.vhd

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

说明 该参数与ImageName参数作用相同,您可以根据实际情况进行二选一设置,即如果设置了ImageName参数,则ImageId参数将被忽略(非必填项)。
ImageName String image****

镜像文件名称,同一个地域内镜像名称唯一。不支持通过该参数设置镜像市场中的镜像。

说明 该参数与ImageId参数作用相同,您可以根据实际情况进行二选一设置,即如果设置了ImageId参数,则ImageName参数将被忽略(非必填项)。
InstanceType String ecs.g6.large

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

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

vCPU个数。单位:核。

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

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

内存大小。单位:GiB。

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

说明 该区间配置效果仅在成本优化模式下且伸缩配置未设置实例规格时生效。
DeploymentSetId String ds-bp1frxuzdg87zh4pz****

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

SecurityGroupId String sg-280ih****

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

IoOptimized String optimized

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

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

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

InternetChargeType String PayByTraffic

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

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

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

InternetMaxBandwidthIn Integer 100

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

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

InternetMaxBandwidthOut Integer 50

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

  • 按带宽计费:0~1024,如果您没有指定该参数,则出带宽将自动被设置为0 Mbps。
  • 按流量计费:0~1024,如果您没有指定该参数,则会出现报错。
SystemDisk.Category String cloud_ssd

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

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

该参数不能与SystemDiskCategories.N同时指定。当该参数与SystemDiskCategories.N都未指定时,该参数有默认值。InstanceType为系列I的实例规格且实例属于非I/O优化实例时,默认值:cloud。否则,默认值:cloud_efficiency。

SystemDisk.Size Integer 100

系统盘的大小,单位: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}。

SystemDisk.DiskName String cloud_ssdSystem

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

SystemDisk.Description String Test system disk.

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

SystemDisk.AutoSnapshotPolicyId String sp-bp12m37ccmxvbmi5****

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

SystemDisk.PerformanceLevel String PL1

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

  • PL0:单盘最高随机读写IOPS 1万。
  • PL1:单盘最高随机读写IOPS 5万。
  • PL2:单盘最高随机读写IOPS 10万。
  • PL3:单盘最高随机读写IOPS 100万。

默认值:PL1。

说明 关于如何选择ESSD云盘性能等级,请参见ESSD云盘
ScalingConfigurationName String scalingconfig****

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

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

LoadBalancerWeight Integer 50

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

默认值:50。

Tags String {"key1":"value1","key2":"value2", ... "key5":"value5"}

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

  • Key最多支持64个字符,不能以aliyun和acs:开头,不能包含http://或者https://。一旦使用标签,Key不允许为空字符串。
  • Value最多支持128个字符,不能以aliyun和acs:开头,不能包含http://或者https://。Value可以为空字符串。
UserData String ZWNobyBoZWxsbyBlY3Mh

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

KeyPairName String KeyPairTest

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

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

ECS实例的RAM角色名称。RAM角色名称由RAM提供和维护,您可调用ListRoles查询可用的RAM角色。创建RAM角色的具体操作,请参见CreateRole

SecurityEnhancementStrategy String Active

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

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

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

HostName String host****

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

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

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

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

默认值:NoSpot。

PasswordInherit Boolean false

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

  • true:使用镜像预设密码。
  • false:不使用镜像预设密码。
Password String 123abc****

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

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

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

说明 如果传入Password参数,建议您使用HTTPS协议发送请求,避免密码泄露。
ResourceGroupId String rg-resource****

ECS实例所属资源组的ID。

HpcClusterId String hpc-clusterid

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

InstanceDescription String Test instance.

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

ClientToken String 123e4567-e89b-12d3-a456-42665544****

保证请求幂等性。

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

Ipv6AddressCount Integer 1

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

CreditSpecification String Standard

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

  • Standard:标准模式。
  • Unlimited:无性能约束模式。

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

ImageFamily String hangzhou-daily-update

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

ZoneId String cn-hangzhou-g

ECS实例所属的可用区ID。

DedicatedHostId String dh-bp67acfmxazb4p****

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

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

Affinity String default

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

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

默认值:default。

Tenancy String default

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

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

默认值:default。

SchedulerOptions Map ["testManagedPrivateSpaceId****"]

调度选项。

PrivatePoolOptions.MatchCriteria String Open

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

  • Open:开放模式。将自动匹配开放类型的私有池容量。如果没有符合条件的私有池容量,则使用公共池资源启动。该模式下无需设置PrivatePoolOptions.Id参数。
  • Target:指定模式。使用指定的私有池容量启动实例,如果该私有池容量不可用,则实例会启动失败。该模式下必须指定私有池ID,即PrivatePoolOptions.Id参数为必填项。
  • None:不使用模式。实例启动将不使用私有池容量。
PrivatePoolOptions.Id String eap-bp67acfmxazb4****

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

SpotDuration Integer 1

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

  • 1:创建后阿里云会保证实例运行1小时不会被自动释放;超过1小时后,系统会自动比较出价与市场价格、检查资源库存,来决定实例的保留或回收。
  • 0:创建后,阿里云不能保证实例运行1小时,系统会自动比较出价与市场价格、检查资源库存,来决定实例的保留或回收。

    说明 实例被回收前5分钟内,阿里云会通过ECS系统事件向您发送通知。抢占式实例按秒计费,建议您结合具体任务执行耗时来选择合适的保留时长。

默认值:1。

SpotInterruptionBehavior String Terminate

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

InstanceTypes.N String ecs.g6.large

多种实例规格参数。其中N的取值范围:1~10,即一个伸缩配置内最多可以设置10种实例规格。

N代表当前伸缩配置中实例规格的优先级,编号为1的实例规格优先级最高,实例规格优先级随着编号的增大依次降低。当无法根据优先级较高的实例规格创建出实例时,弹性伸缩服务会自动选择下一优先级的实例规格来创建实例。

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

当您需要指定伸缩配置中实例规格的容量时,请同时指定本参数和InstanceTypeOverride.N.WeightedCapacity。

本参数用于指定实例规格。您可以指定N个本参数,结合InstanceTypeOverride.N.WeightedCapacity参数,扩展多实例规格支持自定义权重。N的取值范围:1~10。

说明 指定本参数时,不允许同时指定InstanceTypes.N或InstanceType。

InstanceType的取值范围:在售的ECS实例规格,请参见实例规格族

InstanceTypeOverride.N.WeightedCapacity Integer 4

当您需要指定伸缩配置中实例规格的容量时,先指定InstanceTypeOverride.N.InstanceType后,再指定本参数。两个参数一一对应,N需要保持一致。

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

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

例如:

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

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

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

WeightedCapacity的取值范围:1~500。

DataDisk.N.PerformanceLevel String PL1

当数据盘为ESSD云盘时,设置云盘的性能等级。N的取值必须和DataDisk.N.Category=cloud_essd中的N保持一致。取值范围:

  • PL0:单盘最高随机读写IOPS 1万。
  • PL1:单盘最高随机读写IOPS 5万。
  • PL2:单盘最高随机读写IOPS 10万。
  • PL3:单盘最高随机读写IOPS 100万。

默认值:PL1。

说明 关于如何选择ESSD云盘性能等级,请参见ESSD云盘
DataDisk.N.AutoSnapshotPolicyId String sp-bp19nq9enxqkomib****

数据盘使用的自动快照策略ID,N的取值范围:1~16。

DataDisk.N.Encrypted String false

数据盘N是否加密,N的取值范围:1~16。该参数取值范围:

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

默认值:false。

DataDisk.N.Description String Test data disk.

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

DataDisk.N.SnapshotId String s-280s7****

创建数据盘时使用的快照,N的取值范围:1~16。指定该参数后,DataDisk.N.Size会被忽略,实际创建的磁盘大小为指定快照的大小。

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

DataDisk.N.Categories.N String cloud

数据盘N的多磁盘类型。第一个N表示第N块数据盘,取值范围:1~16。第二个N表示第N块数据盘的第N种磁盘类型,取值范围:1~4,即一个伸缩配置内最多可以为数据盘指定4种磁盘类型。N越小,优先级越高。当无法使用高优先级的磁盘类型时,弹性伸缩自动尝试下一优先级的磁盘类型创建数据盘。取值范围:

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

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

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

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

DataDisk.N.Device String /dev/xvdb

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

DataDisk.N.DiskName String cloud_ssdData

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

DataDisk.N.Category String cloud_ssd

数据盘N的磁盘种类,N的取值范围:1~16。该参数取值范围:

  • cloud:普通云盘。随实例创建的普通云盘的DeleteWithInstance属性为true。
  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD云盘。
  • ephemeral_ssd:本地SSD盘。
  • cloud_essd:ESSD云盘。
  • cloud_auto:ESSD AutoPL云盘。

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

  • 对于I/O优化实例,默认值为cloud_efficiency。
  • 对于非I/O优化实例,默认值为cloud。
DataDisk.N.DeleteWithInstance Boolean true

指定数据盘是否随实例释放,N的取值范围:1~16。该参数取值范围:

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

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

默认值:true。

DataDisk.N.KMSKeyId String 0e478b7a-4262-4802-b8cb-00d3fb40****

数据盘对应的KMS密钥的ID,N的取值范围:1~16。

DataDisk.N.ProvisionedIops Long 100

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

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

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

  • true:开启。
  • false:未开启。

    说明 DataDisk.Category取值为cloud_auto时才支持设置该参数。

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

SpotPriceLimit.N.PriceLimit Float 0.5

抢占式实例对应的出价,N的取值范围:1~10。SpotStrategy取值为SpotWithPriceLimit时生效。

SpotPriceLimit.N.InstanceType String ecs.g6.large

抢占式实例的实例规格,N的取值范围:1~10。SpotStrategy取值为SpotWithPriceLimit时生效。

SecurityGroupIds.N String sg-bp18kz60mefs****

将ECS实例同时加入多个安全组。N的取值范围与实例能够加入安全组上限有关。更多信息,请参见使用限制下的安全组章节。

说明 不支持同时指定SecurityGroupId和SecurityGroupIds.N。
InstancePatternInfo.N.Cores Integer 2

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

请注意以下信息:

  • InstancePatternInfo.N参数仅适用于伸缩组的网络类型为专有网络。
  • InstancePatternInfo.N参数必须同时配置InstancePatternInfo.N.Cores和InstancePatternInfo.N.Memory。
  • 如果您已经通过InstanceType或InstanceTypes.N参数指定了实例规格,弹性伸缩优先使用您指定的实例规格扩容,当指定的实例规格无库存时,再从符合InstancePatternInfo.N参数值的实例规格中优先使用价格最低的实例规格扩容。
InstancePatternInfo.N.InstanceFamilyLevel String EnterpriseLevel

智能配置模式下,实例规格族级别,用于筛选符合要求的实例规格范围。取值范围:

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

N的取值范围:1~10。

InstancePatternInfo.N.MaxPrice Float 2

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

说明 SpotStrategy设置为SpotWithPriceLimit时,该参数必选。其他情况下,该参数可选。
InstancePatternInfo.N.Memory Float 4

智能配置模式下,实例规格的内存大小,单位为GiB,用于筛选符合要求的实例规格范围。更多信息,请参见实例规格族。N的取值范围:1~10。

InstancePatternInfo.N.ExcludedInstanceType.N String ecs.n1.small/ecs.n1.*/*7*

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

  • ecs.c6.large:表示排除ecs.c6.large实例规格。
  • ecs.c6.*:表示排除整个c6规格族的实例规格。
InstancePatternInfo.N.Architecture.N String X86

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

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

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

InstancePatternInfo.N.BurstablePerformance String Include

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

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

默认值:Include。

InstancePatternInfo.N.InstanceTypeFamilies.N String ["ecs.g6", "ecs.c6", … "ecs.r6"]

指定的实例规格族。N表示可以设置多个实例规格族,N的取值范围:1~10。

InstancePatternInfo.N.MinimumCpuCoreCount Integer 2

实例规格的最小vCPU内核数目。

InstancePatternInfo.N.MaximumCpuCoreCount Integer 4

实例规格的最大vCPU内核数目。

说明 MaximumCpuCoreCount参数值不能超过MinimumCpuCoreCount参数值的4倍。
InstancePatternInfo.N.GpuSpecs.N String NVIDIA V100

指定的GPU类型。

InstancePatternInfo.N.InstanceCategories.N String ["Compute-optimized with GPU" ]

实例规格分类。取值范围:

说明 N表示可以设置多个实例分类,N的取值范围:1~10。
  • General-purpose:通用型。
  • Compute-optimized:计算型。
  • Memory-optimized:内存型。
  • Big data:大数据型。
  • Local SSDs:本地SSD型。
  • High Clock Speed:高主频型。
  • Enhanced:增强型。
  • Shared:共享型。
  • Compute-optimized with GPU:GPU计算型。
  • Visual Compute-optimized:视觉计算型。
  • Heterogeneous Service:异构服务型。
  • Compute-optimized with FPGA:FPGA计算型。
  • Compute-optimized with NPU:NPU计算型。
  • ECS Bare Metal:弹性裸金属服务器。
  • Super Computing Cluster:超级计算集群。
  • High Performance Compute:高性能计算型。
InstancePatternInfo.N.CpuArchitectures.N String ["X86", "ARM" ]

指定实例的CPU架构。取值范围:

说明 N表示可以设置多个CPU架构,N的取值范围:1~2。
  • X86。
  • ARM。
InstancePatternInfo.N.PhysicalProcessorModels.N String ["Intel Xeon(Ice Lake) Platinum 8369B", "Intel Xeon(Skylake) Platinum 8163", … "Intel Xeon(Cascade Lake) Platinum 8269CY"]

实例的处理器型号。N表示可以设置多个处理器型号,N的取值范围:1~10。

InstancePatternInfo.N.MinimumEniQuantity Integer 2

实例期望最小支持挂载的弹性网卡上限。

InstancePatternInfo.N.MinimumEniPrivateIpAddressQuantity Integer 2

实例的期望最小单块弹性网卡的IPv4地址上限。

InstancePatternInfo.N.MinimumEniIpv6AddressQuantity Integer 1

实例期望的最小单块弹性网卡的IPv6地址上限。

InstancePatternInfo.N.MinimumInitialCredit Integer 12

实例期望的最小突发性能实例 t5、t6的初始vCPU积分值。

InstancePatternInfo.N.MinimumBaselineCredit Integer 12

实例期望的最小突发性能实例t5、t6的基准vCPU计算性能(所有vCPU之和)。

InstancePatternInfo.N.MinimumMemorySize Float 4

实例期望的最小内存。单位:GiB。

InstancePatternInfo.N.MaximumMemorySize Float 4

实例期望的最大内存。单位:GiB。

InstancePatternInfo.N.MinimumGpuAmount Integer 2

实例期望的最小GPU数目。取值范围:≥1的正整数。

InstancePatternInfo.N.MaximumGpuAmount Integer 2

实例期望的最大GPU数目。取值范围:≥1的正整数。

SystemDiskCategories.N String cloud

系统盘的多磁盘类型。N的取值范围:1~4,即一个伸缩配置内最多可以为系统盘指定4种磁盘类型。N越小,优先级越高。当无法使用高优先级的磁盘类型时,弹性伸缩自动尝试下一优先级的磁盘类型创建系统盘。取值范围:

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

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

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

默认值:false。

SystemDisk.KMSKeyId String 0e478b7a-4262-4802-b8cb-00d3fb40****

系统盘使用的KMS密钥ID。

SystemDisk.EncryptAlgorithm String AES-256

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

  • AES-256。
  • SM4-128。

默认值:AES-256。

SystemDisk.ProvisionedIops Long 100

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

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

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

  • true:开启。
  • false:未开启。

    说明 SystemDisk.Category取值为cloud_auto时才支持设置该参数。

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

ImageOptions.LoginAsNonRoot Boolean false

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

  • true:是。
  • false:否。

默认值:false。

DeletionProtection Boolean false

ECS实例释放保护属性。该项仅适用于按量付费实例,指是否支持通过ECS管理控制台或API(DeleteInstance)直接释放实例。取值范围:

  • true:开启实例释放保护属性,表示不支持通过ECS管理控制台或API直接释放实例(即防止弹性伸缩中扩容的实例被误删)。
  • false:关闭实例释放保护属性,表示支持通过ECS管理控制台或API直接释放实例。

默认值:false。

说明 该属性不影响弹性伸缩正常的缩容活动,即弹性伸缩发生缩容活动时,开启实例释放保护的按量付费实例可以被正常释放掉。
StorageSetId String ss-bp67acfmxazb4p****

存储集ID。

StorageSetPartitionNumber Integer 2

存储集中的最大分区数量。取值为大于等于2的整数。

CustomPriorities.N.InstanceType String ecs.g6.large

CustomPriorities字段表示ECS实例规格+虚拟交换机组合的自定义优先级。CustomPriorities.N.InstanceType参数表示自定义优先级中的ECS实例的实例规格。

说明 该参数仅在伸缩组的扩缩容策略优先级策略时有效,且该实例规格(InstanceType)必须包含在伸缩配置的实例规格列表中。

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

说明 如果仅指定了部分ECS实例规格+虚拟交换机组合的自定义优先级,则未指定的组合优先级低于指定的组合优先级,且未指定的组合仍会依次按照伸缩组的虚拟交换机顺序、伸缩配置的实例规格顺序确定优先级。例如:伸缩组的虚拟交换机顺序依次为vsw1、vsw2,伸缩配置的实例规格顺序依次为type1、type2,该组合的自定义优先级顺序为["vsw2+type2", "vsw1+type2"],则最终优先级为vsw2+type2> vsw1+type2 > vsw1+type1 > vsw2+type1
CustomPriorities.N.VswitchId String vsw-bp14zolna43z266bq****

CustomPriorities.N.VswitchId参数表示自定义优先级中的虚拟交换机的ID。

说明 该参数仅在伸缩组的扩缩容策略优先级策略时有效,且该交换机(Vswitch)必须包含在伸缩组的交换机列表中。
NetworkInterfaces.N.InstanceType String Primary

弹性网卡类型。使用NetworkInterfaces.N时必须设置主网卡,但不能同时设置SecurityGroupIdSecurityGroupIds.N参数。取值范围:

  • Primary:主网卡。
  • Secondary:辅助网卡。

默认值:Secondary。

NetworkInterfaces.N.NetworkInterfaceTrafficMode String HighPerformance

网卡的通讯模式。取值范围:

  • Standard:使用TCP通讯模式。
  • HighPerformance:开启ERI(Elastic RDMA Interface)接口,使用RDMA通讯模式。

默认值:Standard。

说明 RDMA模式的弹性网卡数量不能超过该实例规格族的限制。更多信息,请参见实例规格族
NetworkInterfaces.N.Ipv6AddressCount Integer 1

为主网卡指定随机生成的IPv6地址数量。您需要注意以下事项:

  • 如果NetworkInterfaces.N.InstanceType取值为Primary时,设置该参数才会生效。
  • 如果NetworkInterface.N.InstanceType取值为Secondary或空值,则不能设置该参数。
  • 设置该参数后,您不能再设置Ipv6AddressCount参数。
NetworkInterfaces.N.SecurityGroupIds.N String sg-uf6ij8dwxh****

弹性网卡所属的一个或多个安全组 ID。您需要注意以下事项:

  • 如果NetworkInterfaces.N.InstanceType取值为Primary时,则必须设置该参数。此时该参数的作用等同于SecurityGroupIds.N,但不能同时再设置SecurityGroupIdSecurityGroupIds.N参数。
  • 如果NetworkInterfaces.N.InstanceType取值为Secondary或空值,则该参数为非必填参数。默认值为ECS实例所属的安全组(即主网卡的安全组)。
DedicatedHostClusterId String dc-2zedxc67zqzt7lb4****

专有宿主机集群ID。

返回数据

名称

类型

示例值

描述

ScalingConfigurationId String asc-bp1ffogfdauy0nu5****

伸缩配置ID。

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

请求ID。

示例

请求示例

http(s)://ess.aliyuncs.com/?Action=CreateScalingConfiguration
&ScalingGroupId=asg-bp14wlu85wrpchm0****
&ImageId=centos6u5_64_20G_aliaegis****.vhd
&ImageName=image****
&InstanceType=ecs.g6.large
&Cpu=2
&Memory=16
&DeploymentSetId=ds-bp1frxuzdg87zh4pz****
&SecurityGroupId=sg-280ih****
&IoOptimized=optimized
&InternetChargeType=PayByTraffic
&InternetMaxBandwidthIn=100
&InternetMaxBandwidthOut=50
&SystemDisk.Category=cloud_ssd
&SystemDisk.Size=100
&SystemDisk.DiskName=cloud_ssdSystem
&SystemDisk.Description=Test system disk.
&SystemDisk.AutoSnapshotPolicyId=sp-bp12m37ccmxvbmi5****
&SystemDisk.PerformanceLevel=PL1
&ScalingConfigurationName=scalingconfig****
&LoadBalancerWeight=50
&Tags={"key1":"value1","key2":"value2", ... "key5":"value5"}
&UserData=ZWNobyBoZWxsbyBlY3Mh
&KeyPairName=KeyPairTest
&RamRoleName=ramrole****
&SecurityEnhancementStrategy=Active
&InstanceName=instance****
&HostName=host****
&SpotStrategy=NoSpot
&PasswordInherit=false
&Password=123abc****
&ResourceGroupId=rg-resource****
&HpcClusterId=hpc-clusterid
&InstanceDescription=Test instance.
&ClientToken=123e4567-e89b-12d3-a456-42665544****
&Ipv6AddressCount=1
&CreditSpecification=Standard
&ImageFamily=hangzhou-daily-update
&ZoneId=cn-hangzhou-g
&DedicatedHostId=dh-bp67acfmxazb4p****
&Affinity=default
&Tenancy=default
&PrivatePoolOptions.MatchCriteria=Open
&PrivatePoolOptions.Id=eap-bp67acfmxazb4****
&SpotDuration=1
&SpotInterruptionBehavior=Terminate
&InstanceTypes=["ecs.g6.large"]
&InstanceTypeOverride=[{"InstanceType":"ecs.c5.xlarge","WeightedCapacity":4}]
&DataDisk=[{"PerformanceLevel":"PL1","AutoSnapshotPolicyId":"sp-bp19nq9enxqkomib****","Encrypted":"false","Description":"Test data disk.","SnapshotId":"s-280s7****","Categories":["cloud"],"Size":100,"Device":"/dev/xvdb","DiskName":"cloud_ssdData","Category":"cloud_ssd","DeleteWithInstance":true,"KMSKeyId":"0e478b7a-4262-4802-b8cb-00d3fb40****","ProvisionedIops":100,"BurstingEnabled":false}]
&SpotPriceLimit=[{"PriceLimit":0.5,"InstanceType":"ecs.g6.large"}]
&SecurityGroupIds=["sg-bp18kz60mefs****"]
&InstancePatternInfo=[{"Cores":2,"InstanceFamilyLevel":"EnterpriseLevel","MaxPrice":2.0,"Memory":4.0,"ExcludedInstanceType":["ecs.n1.small/ecs.n1.*/*7*"],"Architecture":["X86"],"BurstablePerformance":"Include","InstanceTypeFamilies":["[\"ecs.g6\", \"ecs.c6\", … \"ecs.r6\"]"],"MinimumCpuCoreCount":2,"MaximumCpuCoreCount":4,"GpuSpecs":["NVIDIA V100"],"InstanceCategories":["[\"Compute-optimized with GPU\" ]"],"CpuArchitectures":["[\"X86\", \"ARM\" ]"],"PhysicalProcessorModels":["[\"Intel Xeon(Ice Lake) Platinum 8369B\", \"Intel Xeon(Skylake) Platinum 8163\", … \"Intel Xeon(Cascade Lake) Platinum 8269CY\"]"],"MinimumEniQuantity":2,"MinimumEniPrivateIpAddressQuantity":2,"MinimumEniIpv6AddressQuantity":1,"MinimumInitialCredit":12,"MinimumBaselineCredit":12,"MinimumMemorySize":4.0,"MaximumMemorySize":4.0,"MinimumGpuAmount":2,"MaximumGpuAmount":2}]
&SystemDiskCategories=["cloud"]
&SystemDisk.Encrypted=false
&SystemDisk.KMSKeyId=0e478b7a-4262-4802-b8cb-00d3fb40****
&SystemDisk.EncryptAlgorithm=AES-256
&SystemDisk.ProvisionedIops=100
&SystemDisk.BurstingEnabled=false
&ImageOptions.LoginAsNonRoot=false
&DeletionProtection=false
&StorageSetId=ss-bp67acfmxazb4p****
&StorageSetPartitionNumber=2
&CustomPriorities=[{"InstanceType":"ecs.g6.large","VswitchId":"vsw-bp14zolna43z266bq****"}]
&NetworkInterfaces=[{"InstanceType":"Primary","NetworkInterfaceTrafficMode":"HighPerformance","Ipv6AddressCount":1,"SecurityGroupIds":["sg-uf6ij8dwxh****"]}]
&DedicatedHostClusterId=dc-2zedxc67zqzt7lb4****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateScalingConfigurationResponse>
    <ScalingConfigurationId>asc-bp1ffogfdauy0nu5****</ScalingConfigurationId>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
</CreateScalingConfigurationResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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

HttpCode

错误码

错误信息

描述

400

InstanceType.Mismatch

The specified scaling configuration and existing active scaling configuration have different instance type.

指定的伸缩配置的实例规格与当前的伸缩配置的实例规格不匹配。

404

InvalidDataDiskSnapshotId.NotFound

Snapshot "XXX" does not exist.

不存在指定的快照。

400

InvalidDataDiskSnapshotId.SizeNotSupported

The capacity of snapshot "XXX" exceeds the size limit of the specified disk category.

指定快照的大小超过了磁盘大小的限制。

403

InvalidDevice.InUse

Device "XXX" has been occupied.

数据盘挂载点重复。

400

InvalidImageId.InstanceTypeMismatch

The specified image does not support the specified instance type.

不允许在指定的实例规格下使用该镜像。

404

InvalidImageId.NotFound

The specified image does not exist.

该账号下不存在指定的镜像。

400

InvalidKeyPairName.NotFound

The specified KeyPairName does not exist in our records.

指定的KeyPairName不存在。

400

InvalidNetworkType.ForRAMRole

RAMRole can't be used For classic instance.

经典网络实例不支持RamRoleName参数。

400

InvalidParameter

The specified value of parameter KeyPairName is not valid.

Windows系统不支持KeyPairName参数。

400

InvalidParameter.Conflict

The value of parameter SystemDisk.Category and parameter DataDisk.N.Category are conflict.

指定的系统盘类型和数据盘类型冲突。

400

InvalidRamRole.NotFound

The specified RamRoleName does not exist.

不存在指定的RamRoleName。

400

InvalidScalingConfigurationName.Duplicate

The specified value of parameter ScalingConfigurationName is duplicated.

已存在相同伸缩配置名。

404

InvalidScalingGroupId.NotFound

The specified scaling group does not exist.

该账号下不存在指定的伸缩组。

400

InvalidSecurityGroupId.IncorrectNetworkType

The network type of specified security Group does not support this action.

指定的安全组与伸缩组指定网络类型不一致。

404

InvalidSecurityGroupId.NotFound

The specified security group does not exist.

该账号下不存在指定的安全组。

400

InvalidSecurityGroupId.VPCMismatch

The specified security group and the specified virtual switch are not in the same VPC.

指定的安全组和虚拟交换机不属于同一个虚拟专有网络。

403

InvalidSnapshot.TooOld

This operation is denied because the specified snapshot is created before 2013-07-15.

该快照创建于2013年7月15日或之前,调用被拒绝。

403

InvalidSystemDiskCategory.ValueUnauthorized

The system disk category is not authorized.

没有创建临时磁盘系统盘的权限。

400

InvalidUserData.Base64FormatInvalid

The specified parameter UserData must be base64 encoded.

UserData不符合Base64编码规范。

400

InvalidUserData.SizeExceeded

The specified parameter UserData exceeds the size.

指定的UserData过长。

403

QuotaExceeded.EphemeralDiskSize

Ephemeral disk size quota exceeded.

临时磁盘数据盘总容量超过2 TiB(2048 GiB)。

400

QuotaExceeded.ScalingConfiguration

Scaling configuration quota exceeded in the specified scaling group.

您目前拥有的伸缩配置个数已经达到上限。

400

QuotaExceeded.SecurityGroupInstance

Instance quota exceeded in the specified security group.

指定的安全组中添加的ECS实例个数已经达到上限。

  • 本页导读 (1)