文档

DescribeScalingGroups - 查询伸缩组列表

如果您需要查看伸缩组的基本信息、伸缩组内实例、伸缩配置等信息,您可以通过调用API DescribeScalingGroups查询该伸缩组。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ess:DescribeScalingGroupsREAD
  • 全部资源
    *
ess:DescribeScalingGroupsRead
  • ScalingGroup
    acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

请求参数

名称类型必填描述示例值
RegionIdstring

伸缩组所属地域的 ID。

cn-qingdao
PageNumberinteger

伸缩组列表的页码。起始值:1。

默认值:1。

1
PageSizeinteger

分页查询时设置的每页行数。最大值:50。

默认值:10。

10
GroupTypestring

伸缩组管理的实例类型。可能值:

  • ECS:伸缩组内管理的伸缩实例为 ECS 实例。

  • ECI:伸缩组内管理的伸缩实例为 ECI 实例。

ECS
ScalingGroupIdsarray

待查询伸缩组的 ID。

查询结果会忽略失效的伸缩组 ID,并且不报错。

string

待查询伸缩组的 ID。

查询结果会忽略失效的伸缩组 ID,并且不报错。

asg-bp14wlu85wrpchm0****
ScalingGroupNamesarray

待查询的伸缩组的名称。

查询结果会忽略失效的伸缩组名称,并且不报错。

string

待查询的伸缩组的名称。

查询结果会忽略失效的伸缩组名称,并且不报错。

scalinggroup****
ScalingGroupNamestring

伸缩组的名称。

scalinggroup****
ResourceGroupIdstring

待查询的伸缩组所属的资源组 ID。

说明 当没有伸缩组属于当前资源组下时,查询结果为空,并且不会报错。
rg-123******
Tagsarray<object>

伸缩组的标签信息集合。

object

伸缩组的标签信息集合。

Keystring

伸缩组的标签键。

Department
Valuestring

伸缩组的标签值。

Finance

返回参数

名称类型描述示例值
object

伸缩组列表详情。

RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PageNumberinteger

当前页码。

1
PageSizeinteger

每页行数。

10
TotalCountinteger

伸缩组的总数。

1
ScalingGroupsarray<object>

伸缩组信息的集合。

object

伸缩组信息的集合。

VpcIdstring

伸缩组所属 VPC 的 ID。

vpc-bp1vwnn14rqpyiczj****
CreationTimestring

伸缩组的创建时间。

2014-08-14T10:58Z
TotalInstanceCountinteger

伸缩组内所有 ECS 实例的数量。

1
ScalingGroupNamestring

伸缩组的名称。

dyrSuvBOtO1dEdIlIbp****
SpotInstancePoolsinteger

指定可用实例规格的个数,伸缩组将按成本最低的多个规格均衡创建抢占式实例。取值范围:0~10。

5
StoppedCapacityinteger

伸缩组中处于节省停机效果的实例数量。

1
OnDemandPercentageAboveBaseCapacityinteger

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

20
ModificationTimestring

修改时间。

2014-08-14T10:58Z
MinSizeinteger

伸缩组内 ECS 实例台数的最小值。

1
ScalingGroupIdstring

伸缩组的 ID。

asg-bp14wlu85wrpchm0****
CompensateWithOnDemandboolean

当 MultiAZPolicy 取值为 COST_OPTIMIZED 时,如果因价格、库存等原因无法创建足够的抢占式实例,是否允许自动尝试创建按量实例满足 ECS 实例数量要求。可能值:

  • true:允许。
  • false:不允许。
true
ScalingPolicystring

指定伸缩组的回收模式。可能值:

  • recycle:伸缩组的回收模式为停机回收模式。
  • release:伸缩组的回收模式为释放模式。
  • forcerelease:伸缩组的回收模式为强制释放模式。

关于被移出实例的动作,请参见 RemoveInstances

recycle
RemovingWaitCapacityinteger

伸缩组中处于移除挂起状态的 ECS 实例的数量。

1
ActiveCapacityinteger

已成功加入伸缩组,并正常运行的 ECS 实例数量。

1
OnDemandBaseCapacityinteger

已有伸缩组内所需要的按量实例数的最小值,取值范围:0~1000。即当伸缩组内按量实例个数少于该最小值时,系统将优先创建按量实例。

30
ProtectedCapacityinteger

伸缩组中处于保护中状态的 ECS 实例的数量。

1
HealthCheckTypestring

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

  • NONE:不做健康检查。
  • ECS:对伸缩组内的 ECS 实例做健康检查。
  • LOAD_BALANCER: 根据负载均衡(暂不支持 clb 负载均衡类型)健康检查结果判断实例健康状态。
ECS
LifecycleStatestring

伸缩组的状态信息。可能值:

  • Active:生效状态,处于生效状态的伸缩组才能接收执行伸缩规则的请求并触发伸缩活动。

  • Inactive:失效状态,处于失效状态的伸缩组不接收任何执行伸缩规则的请求。

  • Deleting:伸缩组正在删除,处于删除中状态的伸缩组不接收任何执行伸缩规则的请求,并且不能修改伸缩组相关参数。

Active
GroupDeletionProtectionboolean

是否开启了伸缩组删除保护。可能值:

  • true:开启伸缩组删除保护,此时不能删除该伸缩组。
  • false:关闭伸缩组删除保护。
true
ActiveScalingConfigurationIdstring

伸缩组内生效的伸缩配置的 ID。

asc-bp1et2qekq3ojr33****
GroupTypestring

伸缩组管理的实例类型。

ECS
MultiAZPolicystring

多可用区伸缩组 ECS 实例扩缩容策略。可能值:

  • PRIORITY:根据您定义的虚拟交换机(VSwitchIds)扩缩容。当优先级较高的虚拟交换机所在可用区无法创建 ECS 实例时,自动使用下一优先级的虚拟交换机创建 ECS 实例。

  • COST_OPTIMIZED:按 vCPU 单价从低到高进行尝试创建。当伸缩配置设置了抢占式计费方式的多实例规格时,优先创建对应抢占式实例。您可以继续通过 CompensateWithOnDemand 参数指定当抢占式实例由于库存等原因无法创建时,是否自动尝试以按量付费的方式创建。

    说明 COST_OPTIMIZED 仅在伸缩配置设置了多实例规格或者选用了抢占式实例的情况下生效。
  • BALANCE:在伸缩组指定的多可用区之间均匀分配 ECS 实例。如果由于库存不足等原因可用区之间变得不平衡,您可以通过 API RebalanceInstance 平衡资源。

PRIORITY
RemovingCapacityinteger

正在移出伸缩组的 ECS 实例的数量。

0
PendingWaitCapacityinteger

伸缩组中处于加入挂起状态的 ECS 实例的数量。

1
StandbyCapacityinteger

伸缩组中处于备用状态的实例数量。

1
CurrentHostNamestring
说明 该参数未开放使用。
hostname
PendingCapacityinteger

正在加入伸缩组,还未完成相关配置的 ECS 实例的数量。

0
LaunchTemplateIdstring

伸缩组使用的实例启动模板的 ID。

lt-m5e3ofjr1zn1aw7****
TotalCapacityinteger

当伸缩组设置了实例规格权重,表示伸缩组内所有 ECS 实例的加权容量总和。否则,表示伸缩组内所有 ECS 实例的数量

1
DesiredCapacityinteger

伸缩组内 ECS 实例的期望数量,伸缩组会自动将 ECS 实例数量维持在期望实例数。

5
SpotInstanceRemedyboolean

是否开启补齐抢占式实例。开启后,当收到抢占式实例将被回收的系统消息时,伸缩组将尝试创建新的实例,替换掉将被回收的抢占式实例。

true
LaunchTemplateVersionstring

伸缩组使用的实例启动模板的版本。

Default
RegionIdstring

伸缩组所属的地域的 ID。

cn-qingdao
VSwitchIdstring

伸缩组关联虚拟交换机的 ID。

vsw-bp1whw2u46cn8zubm****
MaxSizeinteger

伸缩组内 ECS 实例台数的最大值。

2
DefaultCooldowninteger

伸缩组默认的冷却时间。冷却时间内,该伸缩组不执行其它的伸缩活动,仅针对云监控报警任务触发的伸缩活动有效。

60
VServerGroupsarray<object>

后端服务器组列表。

object

后端服务器组列表。

LoadBalancerIdstring

后端服务器组所属的负载均衡实例的 ID。

147b46d767c-cn-qingdao-cm5****
VServerGroupAttributesarray<object>

后端服务器组属性。

object

后端服务器组属性。

VServerGroupIdstring

后端服务器组属性。

rsp-bp12bjrny****
Weightinteger

后端服务器组的权重。

1
Portinteger

负载均衡实例对外提供服务的端口号。

22
LaunchTemplateOverridesarray<object>

扩展启动模板的实例规格信息。

object

扩展启动模板的实例规格信息。

WeightedCapacityinteger

指定实例规格的权重,即实例规格的单台实例在伸缩组中表示的容量大小。权重越大,满足期望容量所需的本实例规格的实例数量越少。

4
InstanceTypestring

指定的实例规格,会覆盖启动模板中的实例规格。

ecs.c5.xlarge
SpotPriceLimitfloat

本参数用于指定实例启动模板覆盖规格(即LaunchTemplateOverride.InstanceType)的竞价价格上限。

说明 仅当LaunchTemplateId参数指定了启动模板时,该参数才生效。
0.025
AlbServerGroupsarray<object>

ALB 服务器组的相关信息集合。

object

ALB 服务器组的相关信息集合。

AlbServerGroupIdstring

ALB 服务器组的 ID。

sgp-ddwb0y0g6y9bjm****
Weightinteger

弹性伸缩将 ECS 实例添加到 ALB 服务器组后,ECS 实例作为后端服务器的权重。

100
Portinteger

弹性伸缩将 ECS 实例添加到 ALB 服务器组后,ECS 实例使用的端口号。

80
ServerGroupsarray<object>

负载均衡服务器组的相关信息集合。

说明 您可以通过此参数获取伸缩组关联的 ALB 类型服务组和 NLB 类型服务器组的相关信息集合。
object

负载均衡服务器组的相关信息集合。

ServerGroupIdstring

服务器组 ID。

sgp-i9ouakeaerr*****
Typestring

服务器组类型。可能值:

  • ALB:表示应用型负载均衡(Application Load Balancer)。
  • NLB:表示网络型负载均衡(Network Load Balancer)。
ALB
Weightinteger

弹性伸缩将 ECS 实例添加到服务器组后,ECS 实例作为后端服务器的权重。

100
Portinteger

弹性伸缩将 ECS 实例添加到 ALB 服务器组后,ECS 实例使用的端口号。

80
RemovalPoliciesarray

ECS 实例移出伸缩组的策略的集合。可能值:

  • OldestInstance:移出最早创建的 ECS 实例。
  • NewestInstance:移出最新创建的 ECS 实例。
  • OldestScalingConfiguration:移出最早由伸缩配置创建的 ECS 实例。
string

ECS 实例移出伸缩组的策略的集合。可能值:

  • OldestInstance:移出最早创建的 ECS 实例。
  • NewestInstance:移出最新创建的 ECS 实例。
  • OldestScalingConfiguration:移出最早由伸缩配置创建的 ECS 实例。
OldestScalingConfiguration
DBInstanceIdsarray

伸缩组关联 RDS 实例的 ID。

string

伸缩组关联 RDS 实例的 ID。

rm-bp15556qzebg1****
LoadBalancerIdsarray

伸缩组关联的负载均衡实例的 ID 列表。

string

伸缩组关联的负载均衡实例的 ID 列表。

lb-bp19byhscefk3x0li****
VSwitchIdsarray

伸缩组关联虚拟交换机的 ID 集合。如果您使用了 VSwitchIds 参数,VSwitchId 参数将被忽略。

string

伸缩组关联虚拟交换机的 ID 集合。如果您使用了 VSwitchIds 参数,VSwitchId 参数将被忽略。

vsw-bp1whw2u46cn8zubm****
SuspendedProcessesarray

暂停中的流程,如果没有,则返回值为空。可能值:

  • ScaleIn:缩容流程。
  • ScaleOut:扩容流程。
  • HealthCheck:健康检查。
  • AlarmNotification:报警任务。
  • ScheduledAction:定时任务。
string

暂停中的流程,如果没有,则返回值为空。可能值:

  • ScaleIn:缩容流程。
  • ScaleOut:扩容流程。
  • HealthCheck:健康检查。
  • AlarmNotification:报警任务。
  • ScheduledAction:定时任务。
ScaleIn
SystemSuspendedboolean

弹性伸缩是否停止执行伸缩组内的伸缩活动。可能值:

  • true:停止执行伸缩组内的伸缩活动,说明该伸缩组已经连续扩缩容失败超过 7 天。您需要修改伸缩组或者伸缩配置,来恢复伸缩活动的执行。

  • false:执行伸缩组内的伸缩活动。

true
IsElasticStrengthInAlarmboolean
说明 该参数未开放使用。
false
MonitorGroupIdstring

伸缩组关联的云监控应用分组 ID。

1497****
AzBalanceboolean

伸缩组的容量是否在多个可用区间均衡分布(仅当MultiAZPolicy参数取值为COMPOSABLE策略时生效),可能值:

  • true:伸缩组的容量在多个可用区间均衡分布。
  • false:伸缩组的容量不在多个可用区间均衡分布。
false
AllocationStrategystring

容量分配策略,决定了伸缩组如何选择可用的实例规格类型满足容量。容量分布策略同时对按量和抢占式容量生效(仅当MultiAZPolicy参数取值为COMPOSABLE策略时生效)。可能值:

  • priority:按照配置的实例规格的顺序创建实例。
  • lowestPrice:按照实例规格单位 vCpu 价格从低到高创建实例。
priority
SpotAllocationStrategystring

抢占式容量分布策略。您可以通过该参数单独指定抢占式容量的分布策略(仅当MultiAZPolicy参数取值为COMPOSABLE策略时生效)。可能值:

  • priority:按照配置的实例规格的顺序创建实例。
  • lowestPrice:按照实例规格单位 vCpu 价格从低到高创建实例。

默认值:priority。

lowestPrice
MaxInstanceLifetimeinteger

实例在伸缩组中存活的最大时间。单位为秒。

取值范围:0 或[86400, Integer.maxValue]。其中,0 表示清空 MaxInstanceLifetime 设置过的值(即未设置 MaxInstanceLifetime 值)。

默认值:null。

说明 ECI 类型的伸缩组或停机不收费的伸缩组不支持设置该参数。
null
CustomPolicyARNstring

自定义缩容策略 Function 函数 ARN。仅当 RemovalPolicies 配置第一个移除策略为 CustomPolicy 时生效。

acs:fc:cn-zhangjiakou:16145688****:services/ess_custom_terminate_policy.LATEST/functions/ess_custom_terminate_policy_name
InitCapacityinteger

伸缩组中处于实例扩容前初始化状态的实例数量。

0
ResourceGroupIdstring

伸缩组所属的资源组 ID。

rg-123****
LoadBalancerConfigsarray<object>

负载均衡配置列表。

object

负载均衡配置列表。

LoadBalancerIdstring

负载均衡 CLB(原 SLB)实例的 ID。

lb-2zep8alpq5zq1a2xwyxxx
Weightinteger

弹性伸缩将 ECS 实例添加到 SLB 服务器组后,ECS 实例作为后端服务器的权重。权重越高,ECS 实例将被分配到越多的访问请求。如果权重为 0,则 ECS 实例不会收到访问请求。取值范围:0~100。

10
EnableDesiredCapacityboolean

是否开启期望实例数标识。可能值:

  • true:已开启期望实例数。
  • false:未开启期望实例数。
false
Tagsarray<object>

伸缩组的标签信息集合。

object

伸缩组的标签信息集合。

TagKeystring

伸缩组的标签键。

Department
TagValuestring

伸缩组的标签值。

Finance
Propagateboolean

标识该标签是否为可传播标签,可能值:

  • true:伸缩组上的标签只会传播到新创建的实例上,而不会传播到已经在伸缩组中运行的实例上。
  • false:伸缩组上的标签不会传播到实例上。

默认值:false。

false
HealthCheckTypesarray

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

  • NONE:不做健康检查。
  • ECS:对伸缩组内的 ECS 实例做健康检查。
  • LOAD_BALANCER: 根据负载均衡(暂不支持 clb 负载均衡类型)健康检查结果判断实例健康状态。
string

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

  • NONE:不做健康检查。
  • ECS:对伸缩组内的 ECS 实例做健康检查。
  • LOAD_BALANCER: 根据负载均衡(暂不支持 clb 负载均衡类型)健康检查结果判断实例健康状态。
ECS
DBInstancesarray<object>

伸缩组关联的数据库列表。

object

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

DBInstanceIdstring

数据库实例 ID。

rm-m5eqju85s45mu0***
Typestring

数据库类型。可能值:

  • RDS。
  • Redis。
  • MongoDB。
RDS
SecurityGroupIdsarray

伸缩组向数据库添加的安全组白名单列表。

string

伸缩组向数据库添加的安全组白名单。

当 DetachDBInstances 接口中的RemoveSecurityGroup参数取值为true时,将从数据库安全组白名单中移除此列表中的安全组。

sg-uf65zt66cf2a0q47***

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "ScalingGroups": [
    {
      "VpcId": "vpc-bp1vwnn14rqpyiczj****",
      "CreationTime": "2014-08-14T10:58Z",
      "TotalInstanceCount": 1,
      "ScalingGroupName": "dyrSuvBOtO1dEdIlIbp****",
      "SpotInstancePools": 5,
      "StoppedCapacity": 1,
      "OnDemandPercentageAboveBaseCapacity": 20,
      "ModificationTime": "2014-08-14T10:58Z",
      "MinSize": 1,
      "ScalingGroupId": "asg-bp14wlu85wrpchm0****",
      "CompensateWithOnDemand": true,
      "ScalingPolicy": "recycle",
      "RemovingWaitCapacity": 1,
      "ActiveCapacity": 1,
      "OnDemandBaseCapacity": 30,
      "ProtectedCapacity": 1,
      "HealthCheckType": "ECS",
      "LifecycleState": "Active",
      "GroupDeletionProtection": true,
      "ActiveScalingConfigurationId": "asc-bp1et2qekq3ojr33****",
      "GroupType": "ECS",
      "MultiAZPolicy": "PRIORITY",
      "RemovingCapacity": 0,
      "PendingWaitCapacity": 1,
      "StandbyCapacity": 1,
      "CurrentHostName": "hostname",
      "PendingCapacity": 0,
      "LaunchTemplateId": "lt-m5e3ofjr1zn1aw7****",
      "TotalCapacity": 1,
      "DesiredCapacity": 5,
      "SpotInstanceRemedy": true,
      "LaunchTemplateVersion": "Default",
      "RegionId": "cn-qingdao",
      "VSwitchId": "vsw-bp1whw2u46cn8zubm****",
      "MaxSize": 2,
      "DefaultCooldown": 60,
      "VServerGroups": [
        {
          "LoadBalancerId": "147b46d767c-cn-qingdao-cm5****",
          "VServerGroupAttributes": [
            {
              "VServerGroupId": "rsp-bp12bjrny****",
              "Weight": 1,
              "Port": 22
            }
          ]
        }
      ],
      "LaunchTemplateOverrides": [
        {
          "WeightedCapacity": 4,
          "InstanceType": "ecs.c5.xlarge",
          "SpotPriceLimit": 0.025
        }
      ],
      "AlbServerGroups": [
        {
          "AlbServerGroupId": "sgp-ddwb0y0g6y9bjm****",
          "Weight": 100,
          "Port": 80
        }
      ],
      "ServerGroups": [
        {
          "ServerGroupId": "sgp-i9ouakeaerr*****",
          "Type": "ALB",
          "Weight": 100,
          "Port": 80
        }
      ],
      "RemovalPolicies": [
        "OldestScalingConfiguration"
      ],
      "DBInstanceIds": [
        "rm-bp15556qzebg1****"
      ],
      "LoadBalancerIds": [
        "lb-bp19byhscefk3x0li****"
      ],
      "VSwitchIds": [
        "vsw-bp1whw2u46cn8zubm****"
      ],
      "SuspendedProcesses": [
        "ScaleIn"
      ],
      "SystemSuspended": true,
      "IsElasticStrengthInAlarm": false,
      "MonitorGroupId": "1497****",
      "AzBalance": false,
      "AllocationStrategy": "priority",
      "SpotAllocationStrategy": "lowestPrice",
      "MaxInstanceLifetime": 0,
      "CustomPolicyARN": "acs:fc:cn-zhangjiakou:16145688****:services/ess_custom_terminate_policy.LATEST/functions/ess_custom_terminate_policy_name",
      "InitCapacity": 0,
      "ResourceGroupId": "rg-123****",
      "LoadBalancerConfigs": [
        {
          "LoadBalancerId": "lb-2zep8alpq5zq1a2xwyxxx",
          "Weight": 10
        }
      ],
      "EnableDesiredCapacity": false,
      "Tags": [
        {
          "TagKey": "Department",
          "TagValue": "Finance",
          "Propagate": false
        }
      ],
      "HealthCheckTypes": [
        "ECS"
      ],
      "DBInstances": [
        {
          "DBInstanceId": "rm-m5eqju85s45mu0***\n",
          "Type": "RDS",
          "SecurityGroupIds": [
            "sg-uf65zt66cf2a0q47***"
          ]
        }
      ]
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-04-23OpenAPI 返回结构发生变更查看变更详情
2024-02-01OpenAPI 返回结构发生变更查看变更详情
2023-11-14OpenAPI 返回结构发生变更查看变更详情
2023-10-09OpenAPI 返回结构发生变更查看变更详情
2023-09-19OpenAPI 入参发生变更查看变更详情
2023-06-27OpenAPI 返回结构发生变更查看变更详情
2023-03-30OpenAPI 返回结构发生变更查看变更详情
2022-12-22OpenAPI 返回结构发生变更查看变更详情