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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：DescribeScalingGroups

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

Version string 必选示例值：2020-01-01

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

ProjectName string 可选示例值：default

伸缩组所属项目。

ScalingGroupIds.N string[] 可选示例值：scg-ybmssdnnhn5pkgyd****

伸缩组ID列表。

参数 - N：表示伸缩组的序号，取值：1～10。

多个伸缩组ID之间用&分隔。

TagFilters.N.Key string[] 可选示例值：k1

用户标签的标签键。

参数 - N：表示标签键的序号，取值范围：1～20。

多个标签键之间用&分隔。不允许重复。

TagFilters.N.Value string[] 可选示例值：v1

用户标签的标签值。

参数 - N：表示标签值的序号。取值范围：1～20。

多个标签值之间用&分隔。

TagFilters.N.Values.N string[] 可选示例值：TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2

根据标签查询资源时指定的标签值。 - 第一个N：表示标签键的序号，取值范围：1～10。 - 第二个N：表示标签值的序号，取值范围：1～3，即同一标签键最多支持同时查询3个标签值。 - 多个标签值之间用&分隔。

说明

如果传入该参数，则必须先传入TagFilters.N.Key。

不传则表示查询同一标签键下的所有标签值。

传入空字符串时，表示查询标签值为空的标签。

PageNumber integer 可选示例值：1

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

PageSize integer 可选示例值：10

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

ScalingGroupNames.N string[] 可选示例值：scaling-group-1

伸缩组名称。

参数 - N：表示伸缩组的序号，取值：1～10。

多个伸缩组名称之间用&分隔。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

PageNumber integer 示例值：1

当前页数。

PageSize integer 示例值：10

当前分页的行数。

ScalingGroups object[] 示例值：--

符合条件的伸缩组信息。

ActiveScalingConfigurationId string 示例值：scc-3u1mfze31u3dllw****

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

ScalingGroupId string 示例值：scg-ybmssdnnhn5pkgyd****

伸缩组ID。

DesireInstanceNumber integer 示例值：1

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

CreatedAt string 示例值：2022-04-10T18:29:38+08:00

伸缩组的创建时间。

MaxInstanceNumber integer 示例值：100

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

MinInstanceNumber integer 示例值：0

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

TotalInstanceCount integer 示例值：1

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

UpdatedAt string 示例值：2022-04-14T18:29:38+08:00

伸缩组的更新时间。

VpcId string 示例值：vpc-2fevwte3frk0059gp67d6****

伸缩组所属私有网络ID。

DBInstanceIds string[] 示例值：rds-mysql-42b38c76****

伸缩组关联的RDS数据库信息。

ServerGroupAttributes object[] 示例值：--

伸缩组关联的负载均衡信息。

LoadBalancerId string 示例值：clb-12augb3oetgxs17q7y24a****

负载均衡ID。

ServerGroupId string 示例值：rsp-12b2z5fnxvhts17q7y2fj****

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

Port integer 示例值：80

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

Weight integer 示例值：20

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

Type string 示例值：CLB

负载均衡类型。取值：

CLB：传统型负载均衡。

ALB：应用型负载均衡。

LifecycleState string 示例值：Active

伸缩组的状态。取值：

Active：已启用。

InActive：未激活。

Deleting：删除中。

Locked: 已锁定。

CoolingDown: 冷却中。

Unknown: 未知状态。

MultiAZPolicy string 示例值：PRIORITY

扩缩容策略。取值：

PRIORITY：优先级策略。

BALANCE：均衡分布策略。

选择策略后的实例扩缩容情况请参见创建伸缩组中的“扩缩容”参数说明。

ScalingGroupName string 示例值：scaling-group-test

伸缩组名称。

DefaultCooldown integer 示例值：10

伸缩组的冷却时间。

InstanceTerminatePolicy string 示例值：NewestInstance

实例移除策略，取值：

OldestInstance：移出最早加入（包括自动创建和手动添加）伸缩组的实例。

NewestInstance：移出最晚加入（包括自动创建和手动添加）伸缩组的实例。

OldestScalingConfigurationWithOldestInstance（默认）：移出最早与伸缩组绑定的伸缩配置中，最早由伸缩组自动创建的实例。

OldestScalingConfigurationWithNewestInstance：移出最早与伸缩组绑定的伸缩配置中，最晚由伸缩组自动创建的实例。

SubnetIds string[] 示例值：subnet-24sdlkdplsjkdjd****

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

LaunchTemplateId string 示例值：lt-yc5kwj1di33uw1qj****

实例启动模板的ID。

LaunchTemplateOverrides object[] 示例值：--

实例启动模版信息。

InstanceType string 示例值：ecs.g2a.large

实例规格。

WeightedCapacity integer 示例值：1

实例规格的权重。

PriceLimit float 示例值：0.001

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

说明

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

LaunchTemplateVersion string 示例值：Default

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

Default：始终使用模板默认版本。

Latest：始终使用模板最新版本。

其他值：模板的某个版本号。

StoppedInstanceCount integer 示例值：10

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

HealthCheckType string 示例值：ECS

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

NONE：不做实例健康状态检查。

ECS：对伸缩组内的ECS实例做健康检查。

Tags object[] 示例值：--

伸缩组的标签信息。

Key string 示例值：k1

标签键。

Value string 示例值：v1

标签值。

ScalingMode string 示例值：release

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

release：释放模式。

recycle：停机回收模式。

ProjectName string 示例值：default

伸缩组所属项目名称。

InstancesDistribution object 示例值：--

按量实例和抢占式实例混合配置，仅当伸缩组绑定的伸缩配置来源的计费类型为抢占式类型时生效。

OnDemandBaseCapacity integer 示例值：0

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

OnDemandPercentageAboveBaseCapacity integer 示例值：0

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

CompensateWithOnDemand boolean 示例值：false

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

SpotInstanceRemedy boolean 示例值：false

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

LoadBalancerHealthCheckGracePeriod integer 示例值：60

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

SuspendedProcesses string[] 示例值：ScaleIn

暂停中的流程，无暂停中流程则返回空值。取值：

ScaleIn：缩容流程。

ScaleOut：扩容流程。

HealthCheck：健康检查。

AlarmNotification：报警任务。

ScheduledAction：定时任务。

TotalCount integer 示例值：20

符合条件的伸缩组总数。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidTagKey.Malformed	The specified TagKey is malformed.	指定的标签键不合法。
400	InvalidTagValue.Malformed	The specified TagValue is malformed.	指定的标签值不合法。
400	LimitExceeded.ScalingGroupIds	You've reached the limit on the number of ScalingGroupIds.	已达到伸缩组ID数量上限。
400	LimitExceeded.ScalingGroupNames	You've reached the limit on the number of ScalingGroupNames.	已达到伸缩组名称数量上限。
400	LimitExceeded.TagFilterKeys	You've reached the limit on the number of TagFilter Keys that you can set.	已达到标签过滤键的数量上限。
400	MissingParameter.TagKey	The required parameter TagFiltersKey is not supplied.	标签过滤键不能为空。
400	LimitExceeded.TagFiltersValues	You've reached the limit on the number of TagFilters.N.Values that you can set.	已达到标签过滤值的数量上限。
409	InvalidTagFilterKey.Conflict	The specified TagFilterKey already exists.	指定的标签过滤键冲突。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。

弹性伸缩