首页 弹性伸缩 API参考 API参考(2022-02-22) API目录 伸缩配置 ModifyScalingConfiguration - 修改一个ECS类型伸缩配置

ModifyScalingConfiguration - 修改一个ECS类型伸缩配置

修改一个伸缩配置。

接口说明

如果修改伸缩配置的名称,请注意同一伸缩组下不能存在名称相同的伸缩配置。

调试

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

调试

授权信息

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

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

请求参数

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

待修改伸缩配置的ID。

asc-bp16har3jpj6fjbx****
IoOptimizedstring

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

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

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

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

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

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

test-modify
InstanceNamestring

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

inst****
HostNamestring

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

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

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

说明如果伸缩配置之前使用的镜像包括系统盘和数据盘,修改此镜像后,原数据盘信息会被清除。
centos6u5_64_20G_aliaegis_2014****.vhd
ImageNamestring

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

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

suse11sp3_64_20G_aliaegis_2015****.vhd
Cpuinteger

vCPU个数。单位:核。

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

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

内存大小。单位:GiB。

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

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

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

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

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

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

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

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

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

cloud_efficiency
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}。

50
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万。
说明关于如何选择ESSD云盘性能等级,请参见ESSD云盘
PL0
LoadBalancerWeightinteger

后端服务器的权重,取值范围:1~100。

50
UserDatastring

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

echo hello ecs!
KeyPairNamestring

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

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

ECS实例的RAM角色名称。RAM角色名称由RAM提供和维护,您可调用ListRoles接口查询可用的RAM角色。创建RAM角色的方法,请参见API CreateRole。

RamRoleTest
PasswordInheritboolean

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

false
Tagsstring

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

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

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

ds-bp13v7bjnj9gis****
SecurityGroupIdstring

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

sg-F876F****
Overrideboolean

是否覆盖。取值范围:

  • true:覆盖。
  • false:不覆盖。
true
ResourceGroupIdstring

ECS实例所属资源组的ID。

abcd1234abcd****
HpcClusterIdstring

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

hpc-clusterid
InstanceDescriptionstring

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

Test instance.
Ipv6AddressCountinteger

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

1
CreditSpecificationstring

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

Standard
ImageFamilystring

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

hangzhou-daily-update
ZoneIdstring

ECS实例所属的可用区ID。

cn-hangzhou-g
DedicatedHostIdstring

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

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

dh-bp67acfmxazb4p****
Affinitystring

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

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

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

default
Tenancystring

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

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

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

default
SchedulerOptionsobject

调度选项。

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

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

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

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

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

Open
PrivatePoolOptions.Idstring

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

eap-bp67acfmxazb4****
SpotDurationinteger

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

  • 保留时长2~6正在邀测中,如需开通请提交工单。
  • 保留时长为0,则为无保护期模式。
1
SpotInterruptionBehaviorstring

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

Terminate
DataDisksobject []

数据盘信息的集合。

PerformanceLevelstring

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

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

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

sp-bp19nq9enxqkomib****
Encryptedstring

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

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

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

Test data disk.
SnapshotIdstring

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

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

s-snapshot****
Categoriesarray

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

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

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

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

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

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

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

100
Devicestring

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

/dev/xvdd
DiskNamestring

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

cloud_ssdData
Categorystring

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

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

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

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

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

cloud_ssd
DeleteWithInstanceboolean

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

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

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

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.125
InstanceTypestring

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

ecs.g6.large
InstanceTypesarray

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

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

string

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

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

ecs.g6.large
InstanceTypeOverridesobject []

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

InstanceTypestring

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

本参数用于指定实例规格。您可以指定多个本参数,结合InstanceTypeOverride.WeightedCapacity参数,扩展多实例规格支持自定义权重。

说明指定本参数时,不允许同时指定instanceTypes。

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

ecs.c5.xlarge
WeightedCapacityinteger

当您需要伸缩组按照实例规格容量进行伸缩时,在指定LaunchTemplateOverride.InstanceType后,再指定本参数。

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

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

例如:

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

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

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

WeightedCapacity的取值范围:1~500。

4
SecurityGroupIdsarray

所属安全组ID。

string

所属安全组ID。

sg-bp18kz60mefs****
InstancePatternInfosobject []

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

Coresinteger

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

请注意以下信息:

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

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

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

2
InstanceFamilyLevelstring

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

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

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

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

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

4
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
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*
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

返回参数

名称类型描述示例值
object

修改伸缩配置后的返回信息。

RequestIdstring

请求ID。

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

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-04-12OpenAPI 入参发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ImageOptions.LoginAsNonRoot
阿里云首页 弹性伸缩 相关技术圈