调用ModifyScalingConfiguration修改一个伸缩配置。
接口说明
如果修改伸缩配置的名称,请注意同一伸缩组下不能存在名称相同的伸缩配置。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ModifyScalingConfiguration | 系统规定参数。取值:ModifyScalingConfiguration。 |
ScalingConfigurationId | String | 是 | asc-bp16har3jpj6fjbx**** | 待修改伸缩配置的ID。 |
IoOptimized | String | 否 | none | 是否为I/O优化实例。取值范围:
|
SpotStrategy | String | 否 | NoSpot | 后付费实例的抢占策略。取值范围:
|
ScalingConfigurationName | String | 否 | test-modify | 伸缩配置的名称,2~64个英文或中文字符,以数字、大小写字母或中文开头,可包含数字、下划线(_)、短划线(-)或半角句号(.)。 在同一地域下同一伸缩组内伸缩配置名称唯一。如果您没有指定该参数,则默认使用伸缩配置的ID。 |
InstanceName | String | 否 | inst**** | 使用本伸缩配置自动创建的ECS实例的名称。 |
HostName | String | 否 | hos**** | 云服务器ECS的主机名。半角句号(.)或短划线(-)不能作为首尾字符,不能连续使用半角句号(.)或短划线(-)。另外,不同类型实例的命名要求如下:
|
ImageId | String | 否 | centos6u5_64_20G_aliaegis_2014****.vhd | 镜像文件ID,自动创建实例时使用的镜像资源。 说明 如果伸缩配置之前使用的镜像包括系统盘和数据盘,修改此镜像后,原数据盘信息会被清除。 |
ImageName | String | 否 | suse11sp3_64_20G_aliaegis_2015****.vhd | 镜像文件名称,同一个地域内镜像名称唯一。如果设置了ImageId,ImageName将被忽略。 不支持通过ImageName设置镜像市场镜像。 |
Cpu | Integer | 否 | 2 | vCPU个数。 同时指定CPU和Memory可以定义实例规格范围,例如,CPU=2且Memory=16可以定义配置为2 vCPU和16 GiB的所有实例规格。弹性伸缩会结合I/O优化、可用区等因素确定可用实例规格集合,并根据价格排序为您创建价格最低的实例。 说明 该区间配置效果仅在成本优化模式下且伸缩配置未设置实例规格时生效。 |
Memory | Integer | 否 | 16 | 内存大小。 同时指定CPU和Memory可以定义实例规格范围,例如,CPU=2且Memory=16可以定义配置为2 vCPU和16 GiB的所有实例规格。弹性伸缩会结合I/O优化、可用区等因素确定可用实例规格集合,并根据价格排序为您创建价格最低的实例。 说明 该区间配置效果仅在成本优化模式下且伸缩配置未设置实例规格时生效。 |
InternetChargeType | String | 否 | PayByBandwidth | 网络计费类型。取值范围:
|
InternetMaxBandwidthOut | Integer | 否 | 50 | 公网出带宽最大值,单位为Mbps(Mega bit per second)。取值范围:
|
SystemDisk.Category | String | 否 | cloud_efficiency | 系统盘的磁盘种类。取值范围:
该参数不能与 |
SystemDisk.Size | Integer | 否 | 50 | 系统盘的大小,单位:GiB。取值范围:
指定该参数后,系统盘大小必须大于等于max{20, ImageSize}。 |
SystemDisk.DiskName | String | 否 | cloud_ssdSystem | 系统盘的名称。长度为2~128个英文或中文字符。必须以大小字母或中文开头,不能以 |
SystemDisk.Description | String | 否 | Test system disk. | 系统盘的描述。长度为2~256个英文或中文字符,不能以 |
SystemDisk.AutoSnapshotPolicyId | String | 否 | sp-bp12m37ccmxvbmi5**** | 系统盘使用的自动快照策略ID。 |
SystemDisk.PerformanceLevel | String | 否 | PL0 | 当系统盘为ESSD云盘时,设置云盘的性能等级。取值范围:
说明 关于如何选择ESSD云盘性能等级,请参见ESSD云盘。 |
LoadBalancerWeight | Integer | 否 | 50 | 后端服务器的权重,取值范围:1~100。 |
UserData | String | 否 | echo hello ecs! | ECS实例的自定义数据,需要以Base64方式编码,编码前的原始数据最多为16 KB。 |
KeyPairName | String | 否 | KeyPair_Name | 登录ECS实例时使用的密钥对的名称。
|
RamRoleName | String | 否 | RamRoleTest | ECS实例的RAM角色名称。RAM角色名称由RAM提供和维护,您可调用ListRoles接口查询可用的RAM角色。创建RAM角色的方法,请参见API CreateRole。 |
PasswordInherit | Boolean | 否 | false | 是否使用镜像预设的密码。使用该参数时,您需要确保使用的镜像已经设置了密码。 |
Tags | String | 否 | {"key1":"value1","key2":"value2", ... "key5":"value5"} | ECS实例的标签。标签以键值对方式传入,最多可以使用20组标签。Key和Value的使用要求如下:
|
DeploymentSetId | String | 否 | ds-bp13v7bjnj9gis**** | ECS实例所属的部署集的ID。 |
SecurityGroupId | String | 否 | sg-F876F**** | ECS实例所属的安全组的ID,同一个安全组内的ECS实例可以互相访问。 |
Override | Boolean | 否 | true | 是否覆盖。取值范围:
|
ResourceGroupId | String | 否 | abcd1234abcd**** | ECS实例所属资源组的ID。 |
HpcClusterId | String | 否 | hpc-clusterid | ECS实例所属的HPC集群的ID。 |
InstanceDescription | String | 否 | Test instance. | ECS实例的描述。长度为2~256个英文或中文字符,不能以 |
Ipv6AddressCount | Integer | 否 | 1 | 为弹性网卡指定随机生成的IPv6地址数量。 |
CreditSpecification | String | 否 | Standard | 修改突发性能实例的运行模式。取值范围: |
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 | 专有宿主机实例是否与专有宿主机关联。取值范围:
|
Tenancy | String | 否 | default | 是否在专有宿主机上创建实例。取值范围:
|
SchedulerOptions | Map | 否 | ["testManagedPrivateSpaceId****"] | 调度选项。 |
PrivatePoolOptions.MatchCriteria | String | 否 | Open | 实例启动的私有池容量选项。弹性保障服务或容量预定服务在生效后会生成私有池容量,供实例启动时选择。取值范围:
|
PrivatePoolOptions.Id | String | 否 | eap-bp67acfmxazb4**** | 私有池ID。即弹性保障服务ID或容量预定服务ID。 |
SpotDuration | Integer | 否 | 1 | 抢占式实例的保留时长,单位:小时。取值范围:0~6。
|
SpotInterruptionBehavior | String | 否 | Terminate | 抢占实例中断模式。目前仅支持Terminate(默认)直接释放实例。 |
DataDisk.N.PerformanceLevel | String | 否 | PL1 | 当数据盘为ESSD云盘时,设置云盘的性能等级。N的取值必须和DataDisk.N.Category=cloud_essd中的N保持一致。取值范围:
说明 关于如何选择ESSD云盘性能等级,请参见ESSD云盘。 |
DataDisk.N.AutoSnapshotPolicyId | String | 否 | sp-bp19nq9enxqkomib**** | 数据盘使用的自动快照策略ID,N的取值范围:1~16。 |
DataDisk.N.Encrypted | String | 否 | false | 数据盘N是否加密,N的取值范围:1~16。该参数取值范围:
|
DataDisk.N.Description | String | 否 | Test data disk. | 数据盘的描述,N的取值范围:1~16。长度为2~256个英文或中文字符,不能以 |
DataDisk.N.SnapshotId | String | 否 | s-snapshot**** | 创建数据盘时使用的快照,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越小,优先级越高。当无法使用高优先级的磁盘类型时,弹性伸缩自动尝试下一优先级的磁盘类型创建数据盘。取值范围:
说明 指定本参数时,不允许同时指定 DataDisk.N.Category 。 |
DataDisk.N.Size | Integer | 否 | 100 | 数据盘N的磁盘大小,N的取值范围:1~16,内存单位为GiB。取值范围:
指定该参数后,磁盘大小必须大于等于快照大小(快照通过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个英文或中文字符。必须以大小字母或中文开头,不能以 |
DataDisk.N.Category | String | 否 | cloud_ssd | 数据盘N的磁盘种类,N的取值范围:1~16。该参数取值范围:
该参数不能与
|
DataDisk.N.DeleteWithInstance | Boolean | 否 | true | 指定数据盘是否随实例释放,N的取值范围:1~16。该参数取值范围:
该参数只可对独立云盘设置(DataDisk.N.Category为cloud、cloud_efficiency、cloud_ssd或cloud_essd),否则会出现报错。 |
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(性能突发)。取值范围:
|
SpotPriceLimit.N.PriceLimit | Float | 否 | 0.125 | 抢占式实例对应的出价,N的取值范围:1~10。SpotStrategy取值为SpotWithPriceLimit时生效。 |
SpotPriceLimit.N.InstanceType | String | 否 | ecs.g6.large | 抢占式实例的实例规格,N的取值范围:1~10。SpotStrategy取值为SpotWithPriceLimit时生效。 |
InstanceTypes.N | String | 否 | ecs.g6.large | 多实例规格参数。如果使用了InstanceTypes.N,InstanceType将被忽略,其中N的取值范围:1~10,即一个伸缩配置内最多可以设置10种实例规格。 N代表当前伸缩配置中实例规格的优先级,编号为1的实例规格优先级最高,实例规格优先级随着编号的增大依次降低。当无法根据优先级较高的实例规格创建出实例时,弹性伸缩服务会自动选择下一优先级的实例规格来创建实例。 |
InstanceTypeOverride.N.InstanceType | String | 否 | ecs.c5.xlarge | 当您需要指定伸缩配置中实例规格的容量时,请同时指定本参数和InstanceTypeOverride.N.WeightedCapacity。 本参数用于指定实例规格。您可以指定N个本参数,结合InstanceTypeOverride.N.WeightedCapacity参数,扩展多实例规格支持自定义权重。N的取值范围:1~10。 说明 指定本参数时,不允许同时指定instanceTypes。 InstanceType的取值范围:在售的ECS实例规格,请参见实例规格族。 |
InstanceTypeOverride.N.WeightedCapacity | Integer | 否 | 4 | 当您需要指定伸缩配置中实例规格的容量时,在指定InstanceTypeOverride.N.InstanceType后,再指定本参数。两个参数一一对应,N需要保持一致。 本参数用于指定实例规格的权重,即实例规格的单台实例在伸缩组中表示的容量大小。权重越大,满足期望容量所需的本实例规格的实例数量越少。 由于每个实例规格的vCPU个数、内存大小等性能指标会有差异,您可以根据自身需求,给不同的实例规格配置不同的权重。 例如:
为满足期望容量,伸缩组将为用户扩容2台ecs.c5.xlarge实例。 说明 扩容时伸缩组的容量不得超过最大容量(MaxSize)与实例规格的最大权重之和。 WeightedCapacity的取值范围:1~500。 |
SecurityGroupIds.N | String | 否 | sg-bp18kz60mefs**** | 所属安全组ID。 |
InstancePatternInfo.N.Cores | Integer | 否 | 2 | 智能配置模式下,实例规格的vCPU内核数目,用于筛选符合要求的实例规格范围。更多信息,请参见实例规格族。N的取值范围:1~10。 请注意以下信息:
|
InstancePatternInfo.N.InstanceFamilyLevel | String | 否 | EnterpriseLevel | 智能配置模式下,实例规格族级别,用于筛选符合要求的实例规格范围。取值范围:
N的取值范围:1~10。 |
InstancePatternInfo.N.MaxPrice | Float | 否 | 2 | 智能配置模式下,按量付费实例或者抢占式实例可接受的每小时最高价格,用于筛选符合要求的实例规格范围。N的取值范围:1~10。 说明 SpotStrategy设置为SpotWithPriceLimit时,该参数必选。其他情况下,该参数可选。 |
InstancePatternInfo.N.Memory | Float | 否 | 4 | 智能配置模式下,实例规格的内存大小,单位为GiB,用于筛选符合要求的实例规格范围。更多信息,请参见实例规格族。N的取值范围:1~10。 |
InstancePatternInfo.N.Architecture.N | String | 否 | X86 | 实例规格所属的架构类型。取值范围:
默认值:包含所有架构类型。 |
InstancePatternInfo.N.BurstablePerformance | String | 否 | Include | 是否为性能突发实例规格。取值范围:
默认值:Include。 |
InstancePatternInfo.N.ExcludedInstanceType.N | String | 否 | ecs.n1.small/ecs.n1.*/*7* | 需要排除的实例规格。通过使用通配符(*)可以排除单个规格或者整个规格族。例如:
说明 如果需要排除多个实例规格,请使用分隔符(/)隔开单个实例规格。例如 ecs.n1.small/ecs.n1.*/*7* 。 |
SystemDiskCategories.N | String | 否 | cloud | 系统盘的多磁盘类型。N的取值范围:1~4,即一个伸缩配置内最多可以为系统盘指定4种磁盘类型。N越小,优先级越高。当无法使用高优先级的磁盘类型时,弹性伸缩自动尝试下一优先级的磁盘类型创建系统盘。取值范围:
说明 指定本参数时,不允许同时指定 SystemDisk.Category 。 |
SystemDisk.Encrypted | Boolean | 否 | false | 是否加密系统盘。取值范围:
默认值:false。 |
SystemDisk.KMSKeyId | String | 否 | 0e478b7a-4262-4802-b8cb-00d3fb40**** | 系统盘使用的KMS密钥ID。 |
SystemDisk.EncryptAlgorithm | String | 否 | AES-256 | 系统盘采用的加密算法。取值范围:
默认值: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(性能突发)。取值范围:
|
ImageOptions.LoginAsNonRoot | Boolean | 否 | false | ECS实例是否使用ecs-user用户登录,更多信息,请参见管理ECS实例的登录名。取值范围:
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** | 请求ID。 |
示例
请求示例
http(s)://ess.aliyuncs.com/?Action=ModifyScalingConfiguration
&ScalingConfigurationId=asc-bp16har3jpj6fjbx****
&IoOptimized=none
&SpotStrategy=NoSpot
&ScalingConfigurationName=test-modify
&InstanceName=inst****
&HostName=hos****
&ImageId=centos6u5_64_20G_aliaegis_2014****.vhd
&ImageName=suse11sp3_64_20G_aliaegis_2015****.vhd
&Cpu=2
&Memory=16
&InternetChargeType=PayByBandwidth
&InternetMaxBandwidthOut=50
&SystemDisk.Category=cloud_efficiency
&SystemDisk.Size=50
&SystemDisk.DiskName=cloud_ssdSystem
&SystemDisk.Description=Test system disk.
&SystemDisk.AutoSnapshotPolicyId=sp-bp12m37ccmxvbmi5****
&SystemDisk.PerformanceLevel=PL0
&LoadBalancerWeight=50
&UserData=echo hello ecs!
&KeyPairName=KeyPair_Name
&RamRoleName=RamRoleTest
&PasswordInherit=false
&Tags={"key1":"value1","key2":"value2", ... "key5":"value5"}
&DeploymentSetId=ds-bp13v7bjnj9gis****
&SecurityGroupId=sg-F876F****
&Override=true
&ResourceGroupId=abcd1234abcd****
&HpcClusterId=hpc-clusterid
&InstanceDescription=Test instance.
&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
&DataDisk=[{"PerformanceLevel":"PL1","AutoSnapshotPolicyId":"sp-bp19nq9enxqkomib****","Encrypted":"false","Description":"Test data disk.","SnapshotId":"s-snapshot****","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.125,"InstanceType":"ecs.g6.large"}]
&InstanceTypes=["ecs.g6.large"]
&InstanceTypeOverride=[{"InstanceType":"ecs.c5.xlarge","WeightedCapacity":4}]
&SecurityGroupIds=["sg-bp18kz60mefs****"]
&InstancePatternInfo=[{"Cores":2,"InstanceFamilyLevel":"EnterpriseLevel","MaxPrice":2.0,"Memory":4.0,"Architecture":["X86"],"BurstablePerformance":"Include","ExcludedInstanceType":["ecs.n1.small/ecs.n1.*/*7*"]}]
&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
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ModifyScalingConfigurationResponse>
<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
</ModifyScalingConfigurationResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}
错误码
访问错误中心查看更多错误码。
HttpCode |
错误码 |
错误信息 |
描述 |
---|---|---|---|
403 |
Forbidden.Unauthorized |
A required authorization for the specified action is not supplied. |
未授权操作当前Action。 |
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. |
指定快照的大小超过了磁盘大小的限制。 |
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 |
InvalidParamter |
The specified value of parameter is not valid. |
指定的参数值无效。 |
400 |
InvalidScalingConfigurationName.Duplicate |
The specified value of parameter is duplicated. |
伸缩配置名已存在。 |
400 |
InvalidSecurityGroupId.IncorrectNetworkType |
The network type of specified Security Group does not support this action. |
指定的安全组与伸缩组指定网络类型不一致。 |
400 |
InvalidSecurityGroupId.VPCMismatch |
The specified security group and the specified virtual switch are not in the same VPC. |
指定的安全组和虚拟交换机不属于同一个虚拟专有网络。 |
400 |
InvalidTags.KeyValue |
The specified tags key/value cannot be empty. |
必须指定Tags参数。 |
400 |
InvalidTags.ListSize |
The specified tags list size cannot be more than "20". |
Tags列表长度超过限制长度。 |
400 |
InvalidUserData.Base64FormatInvalid |
The specified parameter UserData must be base64 encoded. |
UserData不符合Base64编码规范。 |
400 |
InvalidUserData.SizeExceeded |
The specified parameter UserData exceeds the size. |
指定的UserData过长。 |