CreateScalingConfiguration_弹性伸缩_API文档-阿里云OpenAPI开发者门户

接口说明

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

InstancePatternInfo.N：智能配置模式，无需指定具体的实例规格，只需根据业务需求指定实例的 vCPU 核数、内存大小、规格族级别以及最高价格，系统会自动筛选符合要求的实例规格，并优先选择价格最低的实例规格创建 ECS 实例。该模式仅适用于伸缩组的网络类型为专有网络，能够有效降低扩容时实例规格库存不足的情况。
InstanceType：指定一种实例规格。
InstanceTypes.N：指定多种实例规格。
InstanceTypeOverride.N：指定多种实例规格，并为不同的实例规格配置权重。
Cpu 和 Memory：指定 CPU 和内存定义实例规格的范围，弹性伸缩会结合 IO 优化、可用区等因素确定可用实例规格集合，并根据价格排序为您创建价格最低的实例。该方式仅适用于伸缩组的扩缩容策略为成本优化策略，且伸缩配置未指定实例规格的场景。
支持以下任一方式绑定主网卡。但需要注意每次调用接口时只能选用一种方式配置主网卡，两种方式同时使用时将会导致接口调用失败并返回错误信息。
- 通过SecurityGroupId、SecurityGroupIds.N与Ipv6AddressCount等参数直接设置主网卡的相关配置信息。
- 通过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 配置的实例规格。

流控信息

请求速率为700/60(s)。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

ess:CreateScalingConfiguration	Create	全部资源 *	无	无

请求参数

字段名称	字段详情
ScalingGroupIdstring	伸缩配置所属的伸缩组的 ID。示例值:asg-bp14wlu85wrpchm0****参考取值来源: CreateScalingGroup DescribeScalingGroups
ImageIdstring	镜像文件 ID，自动创建实例时使用的镜像资源。展开详情示例值:centos6u5_64_20G_aliaegis****.vhd
ImageNamestring	镜像文件名称，同一个地域内镜像名称唯一。不支持通过该参数设置镜像市场中的镜像。展开详情示例值:image****
InstanceTypestring	ECS 实例的一种实例规格，更多信息，请参见实例规格族。展开详情示例值:ecs.g6.large参考取值来源: DescribePatternTypes
Cpuinteger<int32>	vCPU 个数。单位：核。展开详情示例值:2
Memoryinteger<int32>	内存大小。单位：GiB。展开详情示例值:16
DeploymentSetIdstring	ECS 实例所属的部署集的 ID。示例值:ds-bp1frxuzdg87zh4pz****
SecurityGroupIdstring	ECS 实例所属的安全组的 ID，同一个安全组内的 ECS 实例可以互相访问。示例值:sg-280ih****参考取值来源: DescribeScalingGroups
IoOptimizedstring	是否为 I/O 优化实例。取值范围：展开详情示例值:optimized
InternetChargeTypestring	网络计费类型。取值范围：展开详情示例值:PayByTraffic
InternetMaxBandwidthIninteger<int32>	公网入带宽最大值，单位为 Mbit/s。取值范围：展开详情示例值:10
InternetMaxBandwidthOutinteger<int32>	公网出带宽最大值，单位为 Mbit/s。取值范围：0~100。展开详情示例值:10
SystemDisk.Categorystring	系统盘的磁盘种类。取值范围：展开详情示例值:cloud_ssd
SystemDisk.Sizeinteger<int32>	系统盘大小，单位为 GiB。取值范围：展开详情示例值: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 云盘时，设置云盘的性能等级。取值范围：展开详情示例值:PL1
ScalingConfigurationNamestring	伸缩配置的名称，2~64 英文或中文字符，以数字、大小写字母或中文开头，可包含数字、下划线（_）、短划线（-）或半角句号（.）。展开详情示例值:scalingconfig****参考取值来源: CreateEciScalingConfiguration DescribeScalingConfigurations
LoadBalancerWeightinteger<int32>	ECS 实例作为负载均衡后端服务器时的权重，取值范围：1~100。展开详情示例值:50
Tagsstring	ECS 实例的标签。标签以键值对方式传入，最多可以使用 20 组标签。Key 和 Value 的使用要求如下：展开详情示例值:{"key1":"value1","key2":"value2", ... "key5":"value5"}
UserDatastring	ECS 实例的自定义数据，需要以 Base64 方式编码，编码前的原始数据最多为 32 KB。示例值:ZWNobyBoZWxsbyBlY3Mh
KeyPairNamestring	登录 ECS 实例时使用的密钥对的名称。展开详情示例值:KeyPairTest
RamRoleNamestring	ECS 实例的 RAM 角色名称。RAM 角色名称由 RAM 提供和维护，您可调用 ListRoles 查询可用的 RAM 角色。创建 RAM 角色的具体操作，请参见 CreateRole 。示例值:ramrole****
SecurityEnhancementStrategystring	是否开启安全加固。取值范围：展开详情示例值:Active
InstanceNamestring	使用本伸缩配置自动创建的 ECS 实例的名称。示例值:instance****
HostNamestring	云服务器的主机名。半角句号（.）或短划线（-）不能作为首尾字符，不能连续使用半角句号（.）或短划线（-）。另外，不同类型实例的命名要求如下：展开详情示例值:host****
SpotStrategystring	后付费实例的抢占策略。取值范围：展开详情示例值:NoSpot
PasswordInheritboolean	是否使用镜像预设的密码。使用该参数时，您需要确保使用的镜像已经设置了密码。取值范围：展开详情示例值:false
Passwordstring	ECS 实例的密码。长度为 8 至 30 个字符，必须同时包含大小写英文字母、数字和特殊符号中的三类字符。特殊符号可以是：展开详情示例值:123abc****
ResourceGroupIdstring	ECS 实例所属资源组的 ID。示例值:rg-resource****参考取值来源: DescribeScalingGroups
HpcClusterIdstring	ECS 实例所属的 HPC 集群的 ID。示例值:hpc-clusterid
InstanceDescriptionstring	ECS 实例的描述。长度为 2~256 个英文或中文字符，不能以`http://`和`https://`开头。示例值:Test instance.
ClientTokenstring	保证请求幂等性。展开详情示例值:123e4567-e89b-12d3-a456-42665544****
Ipv6AddressCountinteger<int32>	为弹性网卡指定随机生成的 IPv6 地址数量。示例值:1
CreditSpecificationstring	指定突发性能实例的运行模式。取值范围：展开详情示例值:Standard
ImageFamilystring	镜像族系名称，通过设置该参数来获取当前镜像族系内最新的可用镜像，用于创建实例。如果已经设置了参数`ImageId`，则不能设置该参数。示例值:hangzhou-daily-update
ZoneIdstring	ECS 实例所属的可用区 ID。示例值:cn-hangzhou-g
DedicatedHostIdstring	是否在专有宿主机上创建 ECS 实例。由于专有宿主机不支持创建抢占式实例，指定 DedicatedHostId 参数后，会自动忽略请求中的 SpotStrategy 和 SpotPriceLimit 设置。展开详情示例值:dh-bp67acfmxazb4p****
Affinitystring	专有宿主机实例是否与专有宿主机关联。取值范围：展开详情示例值:default
Tenancystring	是否在专有宿主机上创建实例。取值范围：展开详情示例值:default
SchedulerOptionsobject	调度选项。示例值:["testManagedPrivateSpaceId****"]
PrivatePoolOptions.MatchCriteriastring	实例启动的私有池容量选项。弹性保障服务或容量预定服务在生效后会生成私有池容量，供实例启动时选择。取值范围：展开详情示例值:Open
PrivatePoolOptions.Idstring	私有池 ID。即弹性保障服务 ID 或容量预定服务 ID。示例值:eap-bp67acfmxazb4****
SpotDurationinteger<int32>	抢占式实例的保留时长，单位为小时。取值范围：展开详情示例值:1
SpotInterruptionBehaviorstring	抢占实例中断模式。目前仅支持 Terminate（默认）直接释放实例。示例值:Terminate
InstanceTypesarray<string>	多种实例规格参数。示例值:ecs.g6.large子级条数 <= 10
InstanceTypeOverridearray<object>	实例规格相关信息。子级条数 <= 10
DataDiskarray<object>	数据盘详细信息。子级条数 <= 16
SpotPriceLimitarray<object>	抢占式实例详细信息。子级条数 <= 10
SecurityGroupIdsarray<string>	将 ECS 实例同时加入多个安全组。N 的取值范围与实例能够加入安全组上限有关。更多详情，请参见使用限制下的安全组章节。展开详情示例值:sg-bp18kz60mefs****子级条数 <= 16
InstancePatternInfoarray<object>	智能模式下实例规格相关信息。子级条数 <= 10
SystemDiskCategoriesarray<string>	系统盘的多磁盘类型。N 的取值范围：1~4，即一个伸缩配置内最多可以为系统盘指定 4 种磁盘类型。N 越小，优先级越高。当无法使用高优先级的磁盘类型时，弹性伸缩自动尝试下一优先级的磁盘类型创建系统盘。取值范围：展开详情示例值:cloud子级条数 <= 10
SystemDisk.Encryptedboolean	是否加密系统盘。取值范围：展开详情示例值:false
SystemDisk.KMSKeyIdstring	系统盘使用的 KMS 密钥 ID。示例值:0e478b7a-4262-4802-b8cb-00d3fb40****
SystemDisk.EncryptAlgorithmstring	系统盘采用的加密算法。取值范围：展开详情示例值:AES-256
SystemDisk.ProvisionedIopsinteger<int64>	系统盘预配置的 IOPS（Input/Output Operations Per Second）性能指标。展开详情注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:100
SystemDisk.BurstingEnabledboolean	系统盘是否开启 Burst（性能突发）。取值范围：展开详情示例值:false
ImageOptions.LoginAsNonRootboolean	ECS 实例是否使用`ecs-user`用户登录，更多信息，请参见管理 ECS 实例的登录名。取值范围：展开详情示例值:false
DeletionProtectionboolean	ECS 实例释放保护属性。该项仅适用于按量付费实例，指是否支持通过 ECS 管理控制台或 API（DeleteInstance）直接释放实例。取值范围：展开详情示例值:false
StorageSetIdstring	存储集 ID。示例值:ss-bp67acfmxazb4p****
StorageSetPartitionNumberinteger<int32>	存储集中的最大分区数量。取值为大于等于 2 的整数。示例值:2
CustomPrioritiesarray<object>	ECS 实例规格+虚拟交换机组合的自定义优先级。展开详情子级条数 <= 100
NetworkInterfacesarray<object>	弹性网卡列表。子级条数 <= 10
DedicatedHostClusterIdstring	专有宿主机集群 ID。示例值:dc-2zedxc67zqzt7lb4****
SecurityOptionsobject	安全选项。
HttpEndpointstring	是否启用实例元数据的访问通道。取值范围：展开详情示例值:enabled
HttpTokensstring	访问实例元数据时是否强制使用加固模式（IMDSv2）。取值范围：展开详情示例值:optional
ResourcePoolOptionsobject	创建实例时使用的资源池策略。当您设置该参数后，需要注意：展开详情

返回参数

字段名称	字段详情
ScalingConfigurationIdstring	伸缩配置 ID。示例值:asc-bp1ffogfdauy0nu5****
RequestIdstring	请求 ID。示例值:473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

CreateScalingConfiguration_弹性伸缩_API文档