You need to enable JavaScript to run this app.
导航
弹性伸缩
  • 文档首页
    • /
  • 弹性伸缩

DescribeScalingGroups

最近更新时间：2024.04.11 10:48:15

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

我的收藏

调用 DescribeScalingGroups 获取伸缩组信息。如果不存在匹配的伸缩组，则自动忽略，继续查询其他伸缩组。

请求参数

名字

类型

是否必填

示例值

描述

Action

String

是

DescribeScalingGroups

要执行的操作，取值：DescribeScalingGroups。

Version

String

是

2020-01-01

API的版本，取值为：2020-01-01。

ScalingGroupIds.N

String

否

ScalingGroupIds.1=scg-ybmssdnnhn5pkgyd****&ScalingGroupIds.2=scg-3u1mfi816a3dllwz****

伸缩组ID。

  • 参数 - N：表示伸缩组的序号，取值：1～10。
  • 多个伸缩组ID之间用&分隔。

ScalingGroupNames.N

String

否

ScalingGroupNames.1=scaling-group-1&ScalingGroupNames.2=scaling-group-2

伸缩组名称。

  • 参数 - N：表示伸缩组的序号，取值：1～10。
  • 多个伸缩组名称之间用&分隔。

PageNumber

Integer

否

1

列表的页码，默认值为1。

PageSize

Integer

否

10

分页查询时每页的行数，取值范围：1～50。默认值：10。

ProjectName

String

否

default

伸缩组所属项目。

TagFilters.N.Key

String

否

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

用户标签的标签键。

  • 参数 - N：表示标签键的序号。取值范围：1～20。
  • 多个标签键之间用&分隔。

TagFilters.N.Value

String

否

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

用户标签的标签值。

  • 参数 - N：表示标签值的序号。取值范围：1～20。
  • 多个标签值之间用&分隔。

返回数据

名称

类型

示例值

描述

ScalingGroups

Struct

符合条件的伸缩组信息。具体请参见下表“ScalingGroup结构”。

TotalCount

Integer

20

符合条件的伸缩组总数。

PageNumber

Integer

1

当前页数。

PageSize

Integer

10

当前分页的行数。

ScalingGroup结构

名称

类型

示例值

描述

ScalingGroupId

String

scg-ybmssdnnhn5pkgyd****

伸缩组ID。

ScalingGroupName

String

scaling-group-test

伸缩组名称。

LifecycleState

String

伸缩组的状态。取值：

LaunchTemplateId

String

lt-yc5kwj1di33uw1qj****

实例启动模板的ID。

LaunchTemplateVersion

String

Default

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

  • Default：始终使用模板默认版本。
  • Latest：始终使用模板最新版本。
  • 其他值：模板的某个版本号。

LaunchTemplateOverrides

Struct

实例启动模版信息，具体请参见下表“LaunchTemplateOverride结构”。

VpcId

String

vpc-2fevwte3frk0059gp67d6****

伸缩组所属私有网络ID。

SubnetIds

List

["subnet-24sdlkdplsjkdjd****","subnet-24sdlkdplfsdfjd****"]

伸缩组中实例主网卡的子网ID。

MultiAZPolicy

String

PRIORITY

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

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

InstancesDistribution

Struct

按量实例和抢占式实例混合配置，仅当伸缩组绑定的伸缩配置来源的计费类型为抢占式类型时生效，具体请参见下表"InstancesDistribution结构"。

DefaultCooldown

Integer

200

伸缩组的冷却时间。

ActiveScalingConfigurationId

String

scc-3u1mfze31u3dllw****

伸缩组绑定的伸缩配置的ID。

DesireInstanceNumber

Integer

1

伸缩组中期望运行的实例个数。

InstanceTerminatePolicy

String

NewestInstance

实例移除策略，取值：

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

MinInstanceNumber

Integer

1

伸缩组中实例个数的最小值。

MaxInstanceNumber

Integer

3

伸缩组中实例个数的最大值。

TotalInstanceCount

Integer

1

当前伸缩组内实例的个数。

ServerGroupAttributes

Array of Struct

伸缩组关联的负载均衡信息。具体请参见下表“ServerGroupAttribute结构”。

DBInstanceIds

List

伸缩组关联的RDS数据库信息。具体请参见下表“DBInstanceId结构”。

ScalingMode

String

release

伸缩组实例回收模式。取值：

  • release：释放模式。
  • recycle：停机回收模式。

StoppedInstanceCount

Integer

10

伸缩组内处于"停用中"状态的实例数量。

ProjectName

String

default

伸缩组所属项目名称。

Tags

Struct

伸缩组的标签信息，具体请参见下表“ Tag结构 ”。

HealthCheckType

String

ECS

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

  • NONE：不做实例健康状态检查。
  • ECS：对伸缩组内的ECS实例做健康检查。

LoadBalancerHealthCheckGracePeriod

Integer

60

伸缩组实例CLB健康状况检查宽限期。

CreatedAt

String

2022-04-10T18:29:38+08:00

伸缩组的创建时间。

UpdatedAt

String

2022-04-14T18:29:38+08:00

伸缩组的更新时间。

LaunchTemplateOverride结构

名称

类型

示例值

描述

InstanceType

String

ecs.g2i.large

实例规格。

WeightedCapacity

Integer

1

实例规格的权重。

PriceLimit

Float32

0.001

抢占式实例每小时的最高价格。

说明

仅当启动模版为设置出价上限的抢占式实例（即SpotWithPriceLimit）时有返回值。

InstancesDistribution结构

名称

类型

示例值

描述

OnDemandBaseCapacity

Integer

0

伸缩组中按量计费实例个数的最小值。

OnDemandPercentageAboveBaseCapacity

Integer

0

伸缩组满足最小按量实例数要求后，超出的实例中按量实例应占的比例。

CompensateWithOnDemand

Boolean

false

是否允许使用按量实例补充抢占式容量。

SpotInstanceRemedy

Boolean

false

是否允许抢占式实例到期替换。

ServerGroupAttribute结构

名称

类型

示例值

描述

LoadBalancerId

String

clb-12augb3oetgxs17q7y24a****

负载均衡ID。

Port

Integer

80

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

ServerGroupId

String

rsp-12b2z5fnxvhts17q7y2fj****

负载均衡后端服务器组的ID。

Weight

Integer

20

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

Type

String

CLB

负载均衡类型。取值：

  • CLB：传统型负载均衡。
  • ALB：应用型负载均衡。

DBInstanceId结构

名称

类型

示例值

描述

DBInstanceId

String

rds-mysql-42b38c76****

RDS数据库实例ID。

Tag结构

名称

类型

示例值

描述

Key
Value

String
String

k1
v1

标签键。
标签值。

请求示例

GET /?Action=DescribeScalingGroups&ScalingGroupIds.1=scg-ybmssdnnhn5pkgyd****&Version=2020-01-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: auto_scaling

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202204191739590101742350380108****",
        "Action": "DescribeScalingGroups",
        "Version": "2020-01-01",
        "Service": "auto_scaling",
        "Region": "cn-beijing"
    },
    "Result": {
        "ScalingGroups": [
            {
                "ScalingGroupId": "scg-ybmssdnnhn5pkgyd****",
                "ScalingGroupName": "scaling-group-test",
                "LifecycleState": "InActive",
                "LaunchTemplateId": "", 
                "LaunchTemplateVersion": "",
                "VpcId": "vpc-2fevwte3frk0059gp67d6****",
                "SubnetIds": [
                    "subnet-inaimn26s8ow8gbssyxi****"
                ],
                "DefaultCooldown": 200,
                "ActiveScalingConfigurationId": "scc-3u1mfze31u3dllw****",
                "DesireInstanceNumber": 5,
                "MinInstanceNumber": 1,
                "MaxInstanceNumber": 10,
                "InstancesDistribution": {
                      "OnDemandBaseCapacity": 0,
                      "OnDemandPercentageAboveBaseCapacity": 0,
                      "CompensateWithOnDemand": "false",
                      "SpotInstanceRemedy": "false",
	              },
                "ServerGroupAttributes": [],
                "LaunchTemplateOverride": [],
                "ScalingMode": release,
                "StoppedInstanceCount": 10,
                "ProjectName": default,
                "HealthCheckType": ECS,
                "LoadBalancerHealthCheckGracePeriod": 60,
                "DBInstanceIds": [],
                "Tags": [],
                "CreatedAt": "2022-04-19T08:03:39Z",
                "UpdatedAt": "2022-04-19T08:03:39Z",
                "TotalInstanceCount": 0,
            }
        ],
        "TotalCount": 1,
        "PageNumber": 1,
        "PageSize": 10
    }
}