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

CreateScalingGroup

最近更新时间2024.01.16 14:13:13

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

调用 CreateScalingGroup 创建一个伸缩组,创建成功的伸缩组默认选择发送伸缩活动成功和失败的消息通知。关于消息通知

说明

您的账号首次使用弹性伸缩服务,且通过API调用时,平台会为您自动创建“跨服务访问授权”,允许弹性伸缩服务使用云服务器等产品或其他火山引擎产品使用弹性伸缩服务。

请求参数

名称类型是否必填示例值
描述
ActionStringCreateScalingGroup要执行的操作,取值:CreateScalingGroup。
VersionString2020-01-01API的版本,取值为:2020-01-01。

ScalingGroupName

String

scaling-group-test

伸缩组名称,同一地域下伸缩组名称唯一,取值:

  • 只能以中文、字母开头。
  • 只能包含中文、字母、数字、下划线和中划线 。
  • 长度限制为1 ~ 128个字符。
  • 暂不支持特殊字符。
LaunchTemplateIdStringlt-yc5kwj1di33uw1qj****实例启动模板ID,配置后表示选择启动模版作为伸缩配置来源。

LaunchTemplateVersion

String

Default

实例启动模板的版本。取值:

  • 模板的某个版本号。
  • Default(默认):始终使用模板默认版本。
  • Latest:始终使用模板最新版本。

说明

本参数仅当LaunchTemplateId参数存在取值时生有效。

LaunchTemplateOverrides.N.InstanceType

String

LaunchTemplateOverrides.1.InstanceType=ecs.g1.large

指定实例规格。

  • 参数 - N:表示实例规格的序号,取值为1 ~ 10。
  • 取值 - InstanceType:表示实例规格。
  • 多个实例规格之间用&分隔。
  • 填写后,会覆盖启动模板中原本的实例规格;如不填,表示复用所选启动模版中的规格。

说明

本参数仅当LaunchTemplateId参数存在取值时生有效。

DefaultCooldown

Integer

300

执行一次伸缩活动(添加或移出ECS实例)结束后的冷却时间。
冷却时间内,该伸缩组不执行其它的伸缩活动,仅针对云监控报警任务触发的伸缩活动和伸缩规则有效。
取值范围:5 ~ 86400,单位:秒。默认值:300。

SubnetIds.N

String

SubnetIds.1=subnet-24sdlkdplsjkdjd****

伸缩组中实例主网卡的子网ID。您可以调用DescribeSubnets接口查询子网ID。

  • 参数 - N:表示子网的序号,支持多选。多个子网需属于同一个VPC,同一可用区允许选择多个子网。
  • 参数 - SubnetId:表示子网ID。

MultiAZPolicy

String

PRIORITY

扩缩容策略,如果您选择了多个子网,需配置本参数。取值:

  • PRIORITY(默认):优先级策略。
  • BALANCE:均衡分布策略。
    选择策略后的实例扩缩容情况请参见创建伸缩组中的“扩缩容”参数说明。

InstancesDistribution.OnDemandBaseCapacity

Integer

2000

伸缩组中按量计费实例个数的最小值,取值范围:0~2000。当组中按量计费实例个数少于该值时,将优先创建按量计费的实例。

说明

该参数仅当伸缩组绑定的伸缩配置来源的计费类型为抢占式类型时生效,且该参数不影响最终创建的实例数量,实例数量仍有最大/最小/期望实例数限制。

InstancesDistribution.OnDemandPercentageAboveBaseCapacity

Integer

0

伸缩组满足最小按量实例数要求后,超出的实例中按量实例应占的比例,取值范围:0~100。

说明

该参数仅当伸缩组绑定的伸缩配置来源的计费类型为抢占式类型时生效。

InstancesDistribution.CompensateWithOnDemand

Boolean

false

当因价格、库存等原因无法创建足够的抢占式实例时,是否允许使用按量实例补充抢占式容量。取值:

  • true: 允许。
  • false(默认): 不允许。

InstancesDistribution.SpotInstanceRemedy

Boolean

false

是否允许抢占式实例到期替换。开启则表示在抢占式实例被回收前5分钟左右,伸缩组将主动新建新的抢占式实例替换掉当前抢占式实例。取值:

  • true: 允许。
  • false(默认): 不允许。
MinInstanceNumberInteger1伸缩组中实例个数的最小值,默认取值0 ~ 100。
MaxInstanceNumberInteger10伸缩组中实例个数的最大值,默认取值0 ~ 100。

DesireInstanceNumber

Integer

0

伸缩组中期望运行的实例个数,更多介绍请参见 期望实例数
取值:

  • 不小于最小实例数MinInstanceNumber且不大于最大实例数MaxInstanceNumber
  • 默认值:-1,表示不开启期望实例数能力。此时,伸缩组创建完成后会立即开始伸缩活动自动添加相应个数的实例。

InstanceTerminatePolicy

String

NewestInstance

实例移除策略,取值:

  • OldestInstance:移出最早加入(包括自动创建和手动添加)伸缩组的实例。
  • NewestInstance:移出最晚加入(包括自动创建和手动添加)伸缩组的实例。
  • OldestScalingConfigurationWithOldestInstance(默认):移出最早与伸缩组绑定的伸缩配置中,最早由伸缩组 自动创建 的实例。
  • OldestScalingConfigurationWithNewestInstance:移出 最早与伸缩组绑定的伸缩配置中,最晚由伸缩组 自动创建 的实例。

ServerGroupAttributes.N.Type

String

ServerGroupAttributes.1.Type=CLB&ServerGroupAttributes.2.Type=ALB

负载均衡服务器组类型:

  • 参数 - N:表示负载均衡服务器组的序号,取值 1 ~ 40。单类型的服务器组则最多可选择20个。
  • 参数 - Type:表示负载均衡服务器组的类型。
    • ALB:应用型负载均衡。
    • CLB:传统型型负载均衡。
  • 多个服务器组的ID之间用&分隔。
  • 如不传入本参数,则表示暂不绑定负载均衡。
  • 如传入本参数但不传入取值,则默认选择CLB。

ServerGroupAttributes.N.ServerGroupId

String

ServerGroupAttributes.1.ServerGroupId=rsp-12b2z5fnxvhts17q7y2fj****&ServerGroupAttributes.2.ServerGroupId=rsp-12b2z5fnxvhts17q7y3tf****

负载均衡后端服务器组的ID。您可以调用DescribeServerGroups接口查询后端服务器组ID。

  • 参数 - N:表示服务器组的序号,取值 1 ~ 20。
  • 参数 - ServerGroupId:服务器组ID。
  • 多个服务器组的ID之间用&分隔。
  • 如不填,则表示暂不绑定负载均衡。

ServerGroupAttributes.N.Port

Integer

ServerGroupAttributes.1.Port=80&ServerGroupAttributes.2.Port=8080

负载均衡后端服务器组中服务器的端口号。

  • 参数 - N:表示服务器组的序号,取值 1 ~ 20。
  • 参数 - Port:端口号,取值1 ~ 65535。
  • 多个服务器组的端口号之间用&分隔。
  • 如不填,则表示暂不绑定负载均衡。

ServerGroupAttributes.N.Weight

Integer

ServerGroupAttributes.1.Weight=20&ServerGroupAttributes.2.Weight=30

负载均衡后端服务器组中服务器的权重。

  • 参数 - N:表示服务器组的序号,取值 1 ~ 5。
  • 参数 - Weight:权重,取值0 ~ 100。
  • 多个服务器组的权重之间用&分隔。
  • 如不填,则表示暂不绑定负载均衡。

DBInstanceIds.N

String

DBInstanceIds.1=rds-mysql-42b38c76****&DBInstanceIds.2=rds-mysql-42b88c76****

RDS数据库实例的ID。

  • 参数 - N:表示数据库实例的序号,取值 1 ~ 40。
  • 多个数据库实例的ID之间用&分隔。
  • 如不填,则表示暂不绑定数据库实例。

ScalingMode

String

release

伸缩组的实例回收模式,取值:

  • release(默认):释放模式。
  • recycle:停机回收模式。

HealthCheckType

String

ECS

伸缩组的健康检查方式。取值:

  • NONE:不做实例健康状态检查。
  • ECS(默认):对伸缩组内的ECS实例做健康检查。

ProjectName

String

default

伸缩组所属项目,默认为空。一个资源只能归属于一个项目。

  • 只能包含字母、数字、下划线“_”、点“.”和中划线“-”。
  • 长度限制在64个字符以内。

Tags.N.Key

String

Tags.1.Key=k1&Tags.2.Key=k2

用户标签的标签键。

  • 参数 - N:表示标签键的序号。取值范围:1~50。
  • 多个标签键之间用&分隔。
    命名规则如下:
  • 不能以volc:的任意大小写组合开头。
  • 只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。
  • 长度限制在1~128个字符之间。

同一资源的标签键不允许重复。

Tags.N.Value

String

Tags.1.Value=v1&Tags.2.Value=v2

用户标签的标签值。

  • 参数 - N:表示标签值的序号。取值范围:1~50。
  • 多个标签值之间用&分隔。
    命名规则如下:
  • 只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。
  • 允许为空,长度限制在0~256个字符之间。

如果传入该参数,则必须先传入Tags.N.Key

ClientToken

String

333456899ff****

保证请求幂等性。由客户端自动生成一个参数值,确保不同请求间该参数值唯一,避免当调用API超时或服务器内部错误时,客户端多次重试导致重复性操作。取值:
仅支持ASCII字符,且不能超过64个字符。

返回数据

名称类型
示例值
描述
ScalingGroupIdStringscg-ybmssdnnhn5pkgyd****伸缩组ID。

请求示例

GET /?Action=CreateScalingGroup&ScalingGroupName=scaling-group-test&SubnetIds.1=subnet-inaimn26s8ow8gbssyxi****&MinInstanceNumber=1&MaxInstanceNumber=10&ZoneId=cn-beijing-a&Version=2020-01-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: auto_scaling

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220419160338010225133143077B****",
        "Action": "CreateScalingGroup",
        "Version": "2020-01-01",
        "Service": "auto_scaling",
        "Region": "cn-beijing"
    },
    "Result": {
        "ScalingGroupId": "scg-ybmssdnnhn5pkgyd****"
    }
}