You need to enable JavaScript to run this app.
导航

ModifyScalingConfiguration

最近更新时间2024.01.22 16:05:07

首次发布时间2022.05.13 10:42:44

调用 ModifyScalingConfiguration 修改一个伸缩配置,可选参数如不填则表示不修改。

请求参数

名字类型是否必填示例值
描述
ActionStringModifyScalingConfiguration要执行的操作,取值:ModifyScalingConfiguration。
VersionString2020-01-01API的版本,取值为:2020-01-01。
ScalingConfigurationIdStringscc-ybmt16auaugh9zfy****伸缩配置的ID。您可以调用DescribeScalingConfigurations接口查询伸缩配置ID。

ScalingConfigurationName

String

scaling-config-test

伸缩配置的名称,在同一地域下同一伸缩组内伸缩配置名称唯一。取值:

  • 只能以中文、字母开头 。
  • 只能包含中文、字母、数字、下划线“_”、中划线“-”。
  • 长度限制为1 ~ 128个字符。
  • 暂不支持特殊字符。
ImageIdStringimage-ybmhzqo8u4l8j1ii****镜像ID,伸缩组自动创建实例时使用的镜像资源。您可以调用DescribeImages查询镜像ID。
InstanceTypes.NStringInstanceTypes.1=ecs.g1.large实例的计算规格。您可以调用DescribeAvailableResource查询计算规格的库存信息。
ZoneIdStringcn-beijing-a伸缩配置可用区ID。

HpcClusterId

String

hpcCluster-ycdj7d9ios38dfny****

实例所属的高性能计算集群的ID。
仅当InstanceTypes.N指定为“高性能计算GPU型”时有效。

SpotStrategy

String

NoSpot

实例的抢占策略。取值:

  • NoSpot:表示创建正常按量付费实例。

  • SpotAsPriceGo:表示创建抢占式实例,即系统自动出价,跟随当前市场实际价格。

InstanceName

String

instance-test

实例的名称,取值:

  • 以字母或中文开头。
  • 只能包含中文、字母、数字、下划线“_”、中划线“-”和点号“.”。
  • 长度限制为1~128个字符。

说明

您可以为扩容的各实例设置有序且唯一的实例名称或主机名称,配置规则请参见配置有序且唯一的实例名称或主机名称

InstanceDescription

String

云服务器实例。

实例的描述,取值:

  • 不能以数字、中划线开头。
  • 只能包含中文、字母、数字、下划线和中划线。
  • 长度限制在0 ~ 255之间。

HostName

String

instance-host-name

实例的主机名。取值:

  • Linux实例
    • 允许使用点号分隔字符成多段,每段中允许使用字母、数字或中划线“-”。
    • 不能以点号“.”或中划线“-”开头或结尾,且不能连续使用点号“.”或中划线“-”。
    • Linux系统的主机名长度限制为2~63个字符。
  • Windows实例
    • 允许使用字母、数字或中划线“-”,不能完全是数字。
    • 不能以中划线“-”开头或结尾,且不能连续使用中划线“-”。
    • Windows系统的主机名长度限制在2~15个字符。

如不填,则遵循以下规则自动生成:

  • 结构:iv- + 初始主机名,例如
    iv-3tigy72q3u3vj0******
    已创建实例保持原主机名生成逻辑,不随实例重启发生变化。
  • 初始主机名生成逻辑:
    • Linux:提取实例IDi-之后的全部字符。
    • Windows:提取实例IDi-之后的后12位字符。

说明

您可以为扩容的各实例设置有序且唯一的实例名称或主机名称,配置规则请参见配置有序且唯一的实例名称或主机名称

Password

String

password@123

使用“密码”方式登录实例时,请设置root登录密码:

  • 长度限制在8 ~ 30之间。
  • 密码只能由大写字母、小写字母、数字和特殊字符组成,且必须包含至少三项。
  • 特殊字符可以使用:`~!@#$%^&*()_-+=
  • 不能以“/”和“$6$”开头。

KeyPairName

String

kp-test-123

使用“SSH密钥对”登录实例时,请输入密钥对的名称。
如果同时设置了KeyPairNamePassword,则仅生效KeyPairName

SecurityEnhancementStrategy

String

Active

是否开启安全加固,取值:

  • Active:开启安全加固,仅对公共镜像生效。
  • InActive:关闭安全加固,对所有镜像生效。

Volumes.N.VolumeType

String

Volumes.1.VolumeType=PTSSD&
Volumes.2.VolumeType=PTSSD

云盘的类型:

  • 参数 - N:表示云盘的序号,序号为“1”表示系统盘,序号为“2”或大于“2”表示数据盘。取值:1 ~ 15。
  • 参数 - VolumeType:表示第N个云盘的类型,取值:
    • PTSSD
    • ESSD_FlexPL
    • ESSD_PL0
  • 多个云盘之间用&分隔。

Volumes.N.Size

Integer

Volumes.1.Size=100&
Volumes.2.Size=100

云盘的容量:

  • 参数 - N:表示云盘的序号,序号为“1”表示系统盘;序号为“2”或大于“2”表示数据盘。取值:1 ~ 15。
  • 取值 - Size:表述第N个云盘的容量,单位为GiB。
    • 系统盘取值范围:10 - 500。
    • 数据盘取值范围:10 - 8192。
  • 多个云盘之间用&分隔。

Volumes.N.DeleteWithInstance

Boolean

Volumes.1.DeleteWithInstance=true&
Volumes.2.DeleteWithInstance=false

云盘是否随实例释放:

  • 参数 - N:表示云盘的序号,序号为“1”表示系统盘;序号为“2”或大于“2”表示数据盘。取值:1 - 15。
  • 取值 - DeleteWithInstance:云盘是否随实例释放。
    • true:云盘随实例释放。
    • false:云盘不随实例释放。
  • 取值为false时对系统盘无效,系统盘默认随实例释放,不允许保留。

SecurityGroupIds.N

String

SecurityGroupIds.1=sg-3ti78x9h8t4bw*****&
SecurityGroupIds.2=sg-3cj59ih2v9hj46c6rr*****

实例主网卡关联的安全组ID。您可以调用DescribeSecurityGroups接口查询安全组ID。取值:

  • 参数 - N:表示主网卡关联的安全组的序号,最多支持同时绑定5个安全组,取值:1 ~ 5。
  • 取值 - SecurityGroupIds:表示主网卡关联的第N个安全组的ID。
  • 多个安全组ID之间用&分隔。

Ipv6AddressCount

Integer

1

是否为实例网卡“分配IPv6地址”。取值:

  • 0:不分配IPv6地址。
  • 1:分配IPv6地址,系统自动为您分配IPv6网段。

Eip.Bandwidth

Integer

1

公网IP的带宽峰值,默认为1,单位:Mbps。取值:

  • 当Eip.BillingType取值为PostPaidByBandwidth时,取值为1 ~ 500。
  • 当Eip.BillingType取值为PostPaidByTraffic时,取值为1 ~ 200。

说明

如果您指定的伸缩配置中已配置公网IP,此时指定本参数为0值,则表示删除公网IP配置;如果未配置公网IP,那么配置Eip.BandwidthEip.ISPEip.BillingType中的任意一项后,均可以为伸缩配置添加公网IP配置,未配置参数取默认值。

Eip.ISP

String

BGP

线路类型,取值:

  • BGP(默认):BGP线路。
  • 若您的账号已申请使用静态单线,ISP还可以传入ChinaMobile(表示中国移动)、ChinaTelecom(表示中国电信)、ChinaUnicom(表示中国联通)。

Eip.BillingType

String

PostPaidByBandwidth

公网IP的计费类型,取值:

  • PostPaidByBandwidth(默认):按量计费-按带宽上限计费。
  • PostPaidByTraffic:按量计费-按实际流量计费。

Eip.BandwidthPackageId

String

bwp-2zeo05qre24nhrqpy****

共享带宽包的ID,表示将公网IP加入到共享带宽包。 您可以调用 DescribeBandwidthPackages 接口,查询共享带宽包的ID。 公网IP加入到共享带宽包必须同时满足如下条件:

  • 二者的安全防护类型相同。
  • 二者的线路类型相同。
  • 共享带宽包为IPv4类型。

Eip.SecurityProtectionTypes.N

String

AntiDDoS_Enhanced

公网IP的安全防护类型。

  • 参数 - N:表示安全防护类型的序号,当前仅支持取1。
  • 取值:
    • AntiDDoS_Enhanced:申请增强防护类型的公网IP(可加入到DDoS原生防护实例)。
    • 不填则表示基础防护类型的公网IP。

Eip.SecurityProtectionInstanceId

Interger

193

安全防护包的ID。

说明

Eip.SecurityProtectionTypes.N不为空时,本参数必填。

UserData

String

ZWNobyBoZWxsbyBlY3Mh

实例自定义数据。设置的自定义数据必须经过Base64编码,且Base64编码前的自定义数据大小不能超过16KB。

  • 不填则默认为空。

ProjectName

String

default

伸缩配置创建的实例所属项目。一个资源只能归属于一个项目。

  • 只能包含字母、数字、下划线“_”、点“.”和中划线“-”。

  • 长度限制在64个字符以内。

Tags

String

{"k1":"v1","k2":"v2"}

伸缩配置创建实例的标签。标签以键值对方式传入,最多传入20组标签。

  • Key命名规则如下:

    • 不能以volc:的任意大小写组合开头。

    • 只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。

    • 长度限制在1~128个字符之间。

    同一伸缩配置的标签键不允许重复。

  • Value命名规则如下:

    • 只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。

    • 允许为空,长度限制在0~256个字符之间。

返回数据

名称类型示例值描述
ScalingConfigurationIdStringscc-ybmt16auaugh9zfy****伸缩配置ID。

请求示例

GET /?Action=ModifyScalingConfiguration&Version=2020-01-01&ScalingConfigurationId=scc-ybmt16auaugh9zfy****&ScalingConfigurationName=test HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: auto_scaling

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220419181853010225133143050B****",
        "Action": "ModifyScalingConfiguration",
        "Version": "2020-01-01",
        "Service": "auto_scaling",
        "Region": "cn-beijing"
    },
    "Result": {
        "ScalingConfigurationId": "scc-ybmt16auaugh9zfy****"
    }
}