最近更新时间:2024.03.22 10:51:41
首次发布时间:2022.05.13 10:42:44
调用 CreateScalingGroup 创建一个伸缩组,创建成功的伸缩组默认选择发送伸缩活动成功和失败的消息通知。关于消息通知。
说明
您的账号首次使用弹性伸缩服务,且通过API调用时,平台会为您自动创建“跨服务访问授权”,允许弹性伸缩服务使用云服务器等产品或其他火山引擎产品使用弹性伸缩服务。
名称 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateScalingGroup | 要执行的操作,取值:CreateScalingGroup。 |
Version | String | 是 | 2020-01-01 | API的版本,取值为:2020-01-01。 |
ScalingGroupName | String | 是 | scaling-group-test | 伸缩组名称,同一地域下伸缩组名称唯一,取值:
|
LaunchTemplateId | String | 否 | lt-yc5kwj1di33uw1qj**** | 实例启动模板ID,配置后表示选择启动模版作为伸缩配置来源。 |
LaunchTemplateVersion | String | 否 | Default | 实例启动模板的版本。取值:
说明 本参数仅当 |
LaunchTemplateOverrides.N.InstanceType | String | 否 | LaunchTemplateOverrides.1.InstanceType=ecs.g2i.large | 指定实例规格。
说明 本参数仅当 |
LaunchTemplateOverrides.N.PriceLimit | Float32 | 否 | LaunchTemplateOverrides.1.PriceLimit=0.001 | 指定抢占式实例规格每小时的最高价格。
说明 本参数仅当 |
DefaultCooldown | Integer | 否 | 300 | 执行一次伸缩活动(添加或移出ECS实例)结束后的冷却时间。 |
SubnetIds.N | String | 是 | SubnetIds.1=subnet-24sdlkdplsjkdjd**** | 伸缩组中实例主网卡的子网ID。您可以调用DescribeSubnets接口查询子网ID。
|
MultiAZPolicy | String | 否 | PRIORITY | 扩缩容策略,如果您选择了多个子网,需配置本参数。取值:
|
InstancesDistribution.OnDemandBaseCapacity | Integer | 否 | 2000 | 伸缩组中按量计费实例个数的最小值,取值范围:0~2000。当组中按量计费实例个数少于该值时,将优先创建按量计费的实例。 说明 该参数仅当伸缩组绑定的伸缩配置来源的计费类型为抢占式类型时生效,且该参数不影响最终创建的实例数量,实例数量仍有最大/最小/期望实例数限制。 |
InstancesDistribution.OnDemandPercentageAboveBaseCapacity | Integer | 否 | 0 | 伸缩组满足最小按量实例数要求后,超出的实例中按量实例应占的比例,取值范围:0~100。 说明 该参数仅当伸缩组绑定的伸缩配置来源的计费类型为抢占式类型时生效。 |
InstancesDistribution.CompensateWithOnDemand | Boolean | 否 | false | 当因价格、库存等原因无法创建足够的抢占式实例时,是否允许使用按量实例补充抢占式容量。取值:
|
InstancesDistribution.SpotInstanceRemedy | Boolean | 否 | false | 是否允许抢占式实例到期替换。开启则表示在抢占式实例被回收前5分钟左右,伸缩组将主动新建新的抢占式实例替换掉当前抢占式实例。取值:
|
MinInstanceNumber | Integer | 是 | 1 | 伸缩组中实例个数的最小值,默认取值0 ~ 100。 |
MaxInstanceNumber | Integer | 是 | 10 | 伸缩组中实例个数的最大值,默认取值0 ~ 100。 |
DesireInstanceNumber | Integer | 否 | 0 | 伸缩组中期望运行的实例个数,更多介绍请参见 期望实例数。
|
InstanceTerminatePolicy | String | 否 | NewestInstance | 实例移除策略,取值:
|
ServerGroupAttributes.N.Type | String | 否 | ServerGroupAttributes.1.Type=CLB&ServerGroupAttributes.2.Type=ALB | 负载均衡服务器组类型:
|
ServerGroupAttributes.N.ServerGroupId | String | 否 | ServerGroupAttributes.1.ServerGroupId=rsp-12b2z5fnxvhts17q7y2fj****&ServerGroupAttributes.2.ServerGroupId=rsp-12b2z5fnxvhts17q7y3tf**** | 负载均衡后端服务器组的ID。您可以调用DescribeServerGroups接口查询后端服务器组ID。
|
ServerGroupAttributes.N.Port | Integer | 否 | ServerGroupAttributes.1.Port=80&ServerGroupAttributes.2.Port=8080 | 负载均衡后端服务器组中服务器的端口号。
|
ServerGroupAttributes.N.Weight | Integer | 否 | ServerGroupAttributes.1.Weight=20&ServerGroupAttributes.2.Weight=30 | 负载均衡后端服务器组中服务器的权重。
|
DBInstanceIds.N | String | 否 | DBInstanceIds.1=rds-mysql-42b38c76****&DBInstanceIds.2=rds-mysql-42b88c76**** | RDS数据库实例的ID。
说明 伸缩组关联RDS数据库实例为邀测功能,如需使用,请提交工单或联系客户经理申请。 |
ScalingMode | String | 否 | release | 伸缩组的实例回收模式,取值:
|
HealthCheckType | String | 否 | ECS | 伸缩组的健康检查方式。取值:
|
ProjectName | String | 否 | default | 伸缩组所属项目,默认为空。一个资源只能归属于一个项目。
|
Tags.N.Key | String | 否 | Tags.1.Key=k1&Tags.2.Key=k2 | 用户标签的标签键。
|
Tags.N.Value | String | 否 | Tags.1.Value=v1&Tags.2.Value=v2 | 用户标签的标签值。
|
ClientToken | String | 否 | 333456899ff**** | 保证请求幂等性。由客户端自动生成一个参数值,确保不同请求间该参数值唯一,避免当调用API超时或服务器内部错误时,客户端多次重试导致重复性操作。取值: |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ScalingGroupId | String | scg-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****" } }