文档

DescribeScalingInstances - 查询伸缩组内ECS实例列表

更新时间:

查询伸缩组内ECS实例的列表,并列出ECS实例的信息。

接口说明

您可以通过指定伸缩组 ID 查询该伸缩组内 ECS 实例的列表,也可以指定伸缩配置 ID、健康状态、生命周期状态、创建类型等筛选符合要求的 ECS 实例。

调试

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

调试

授权信息

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

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

请求参数

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

伸缩组所属地域的 ID。

cn-hangzhou
ScalingGroupIdstring

伸缩组的 ID。

asg-bp1igpak5ft1flyp****
ScalingConfigurationIdstring

关联伸缩配置的 ID。

asc-bp1i65jd06v04vdh****
HealthStatusstring

ECS 实例在伸缩组中的健康状态,未处于运行中(Running)状态的 ECS 实例会被判定为不健康的 ECS 实例,取值范围:

  • Healthy:健康的 ECS 实例。
  • Unhealthy:不健康的 ECS 实例。

弹性伸缩会自动移出伸缩组中不健康的 ECS 实例,并释放自动创建的 ECS 实例。

是否释放手动添加的 ECS 实例由其托管状态决定。如果实例生命周期未托管给伸缩组,只移出实例但不释放。如果实例生命周期托管给伸缩组,移出并释放实例。

说明 请确保账号可用额度充足。如果账号欠费,所有后付费的 ECS 实例(包括按量付费实例和抢占式实例)都会停机,甚至被释放。欠费后伸缩组内 ECS 实例状态变化,请参见欠费说明
Healthy
LifecycleStatestring

ECS 实例在伸缩组中的生命周期状态,取值范围:

  • InService:已成功加入伸缩组并正常提供服务。
  • Pending:加入中。ECS 实例加入伸缩组时包括加入负载均衡实例的后端服务器、RDS 实例的访问白名单等过程。
  • Pending:Wait:加入挂起中。如果伸缩组内创建了适用于弹性扩张活动的生命周期挂钩,ECS 实例在加入伸缩组时被挂起并等待挂钩超时时间结束。
  • Protected:保护中。ECS 实例正常提供服务,但弹性伸缩不管理 ECS 实例的生命周期,而是由您手动管理。
  • Standby:备用中。ECS 实例不提供服务,负载均衡权重被置为零,且弹性伸缩不管理 ECS 实例的生命周期,而是由您手动管理。
  • Stopped:停用中。ECS 实例已停机,不提供服务。
  • Removing:移出中。ECS 实例移出伸缩组时包括移出负载均衡实例的后端服务器、RDS 实例的访问白名单等过程。
  • Removing:Wait:移出挂起中。如果伸缩组内创建了适用于弹性收缩活动的生命周期挂钩,ECS 实例在移出伸缩组时被挂起并等待挂钩超时时间结束。
InService
CreationTypestring

伸缩组中实例的创建方式,取值范围:

  • AutoCreated:弹性伸缩根据实例配置信息来源自动创建的 ECS 实例。
  • Attached:不是通过弹性伸缩服务创建,而是由您手动添加到伸缩组中的 ECS 实例。
  • Managed:不是通过弹性伸缩服务创建,而是由您手动添加到伸缩组中的托管实例。
AutoCreated
PageNumberinteger

ECS 实例列表的页码,起始值:1。

默认值:1。

1
PageSizeinteger

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

默认值:10。

10
ScalingActivityIdstring

伸缩活动的 ID。

asa-bp1c9djwrgxjyk31****
InstanceIdsarray

ECS 实例的 ID。

返回查询结果时忽略失效的 InstanceId,并且不报错。

string

ECS 实例的 ID。

返回查询结果时忽略失效的 InstanceId,并且不报错。

i-bp109k5j3dum1ce6****
CreationTypesarray

伸缩组中实例的创建方式,此参数和 CreationType 参数只能同时传入一个。

string

伸缩组中实例的创建方式,可分为 AutoCreated、Attached、Managed。

AutoCreated
LifecycleStatesarray

ECS 实例在伸缩组中的生命周期状态列表,此参数和 LifecycleState 参数只能同时传入一个,建议您使用此参数。

string

ECS 实例在伸缩组中的生命周期状态,取值范围:

  • InService:已成功加入伸缩组并正常提供服务。
  • Pending:加入中。ECS 实例加入伸缩组时包括加入负载均衡实例的后端服务器、RDS 实例的访问白名单等过程。
  • Pending:Wait:加入挂起中。如果伸缩组内创建了适用于弹性扩张活动的生命周期挂钩,ECS 实例在加入伸缩组时被挂起并等待挂钩超时时间结束。
  • Protected:保护中。ECS 实例正常提供服务,但弹性伸缩不管理 ECS 实例的生命周期,而是由您手动管理。
  • Standby:备用中。ECS 实例不提供服务,负载均衡权重被置为零,且弹性伸缩不管理 ECS 实例的生命周期,而是由您手动管理。
  • Stopped:停用中。ECS 实例已停机,不提供服务。
  • Removing:移出中。ECS 实例移出伸缩组时包括移出负载均衡实例的后端服务器、RDS 实例的访问白名单等过程。
  • Removing:Wait:移出挂起中。如果伸缩组内创建了适用于弹性收缩活动的生命周期挂钩,ECS 实例在移出伸缩组时被挂起并等待挂钩超时时间结束。
InService

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

B13527BF-1FBD-4334-A512-20F5E9D3FB4D
PageSizeinteger

每页行数。

10
PageNumberinteger

当前页码。

1
TotalSpotCountinteger

当前伸缩组中,运行状态的抢占式实例总数。

4
TotalCountinteger

ECS 实例的总数。

1
ScalingInstancesobject []

ECS 实例信息组成的集合。

CreationTimestring

ECS 实例加入伸缩组的时间,精确到分钟。

2020-05-18T03:11Z
LoadBalancerWeightinteger

负载均衡实例权重。

50
LaunchTemplateIdstring

实例启动模板的 ID。

lt-m5e3ofjr1zn1aw7****
InstanceIdstring

ECS 实例的 ID。

i-bp109k5j3dum1ce6****
SpotStrategystring

抢占式实例的抢占策略。可能值:

  • SpotWithPriceLimit:设置上限价格的抢占式实例。
  • SpotAsPriceGo:系统自动出价,跟随当前市场实际价格。
SpotWithPriceLimit
LaunchTemplateVersionstring

实例启动模板的版本。

1
HealthStatusstring

ECS 实例在伸缩组中的健康状态,未处于运行中(Running)状态的 ECS 实例会被判定为不健康的 ECS 实例,可能值:

  • Healthy:健康的 ECS 实例。
  • Unhealthy:不健康的 ECS 实例。

弹性伸缩会自动移出伸缩组中不健康的 ECS 实例,并释放自动创建的 ECS 实例。

是否释放手动添加的 ECS 实例由其托管状态决定。如果实例生命周期未托管给伸缩组,只移出实例但不释放。如果实例生命周期托管给伸缩组,移出并释放实例。

说明 请确保账号可用额度充足。如果账号欠费,所有后付费的 ECS 实例(包括按量付费实例和抢占式实例)都会停机,甚至被释放。欠费后伸缩组内 ECS 实例状态变化,请参见欠费说明
Healthy
ScalingGroupIdstring

所属伸缩组的 ID。

asg-bp1igpak5ft1flyp****
WarmupStatestring

ECS 实例的预热状态,可能值:

  • NoNeedWarmup:不需要预热。
  • WaitingForInstanceWarmup:等待预热结束。
  • InstanceWarmupFinish:预热结束。
NoNeedWarmup
LifecycleStatestring

ECS 实例在伸缩组中的生命周期状态,可能值:

  • InService:已成功加入伸缩组并正常提供服务。
  • Pending:加入中。ECS 实例加入伸缩组时包括加入负载均衡实例的后端服务器、RDS 实例的访问白名单等过程。
  • Pending:Wait:加入挂起中。如果伸缩组内创建了适用于弹性扩张活动的生命周期挂钩,ECS 实例在加入伸缩组时被挂起并等待挂钩超时时间结束。
  • Protected:保护中。ECS 实例正常提供服务,但弹性伸缩不管理 ECS 实例的生命周期,而是由您手动管理。
  • Standby:备用中。ECS 实例不提供服务,负载均衡权重被置为零,且弹性伸缩不管理 ECS 实例的生命周期,而是由您手动管理。
  • Stopped:停用中。ECS 实例已停机,不提供服务。
  • Removing:移出中。ECS 实例移出伸缩组时包括移出负载均衡实例的后端服务器、RDS 实例的访问白名单等过程。
  • Removing:Wait:移出挂起中。如果伸缩组内创建了适用于弹性收缩活动的生命周期挂钩,ECS 实例在移出伸缩组时被挂起并等待挂钩超时时间结束。
InService
CreationTypestring

ECS 实例的创建方式,可能值:

  • AutoCreated:弹性伸缩根据实例配置信息来源自动创建的 ECS 实例。
  • Attached:不是通过弹性伸缩服务创建,而是由您手动添加到伸缩组中的 ECS 实例。
AutoCreated
ZoneIdstring

ECS 实例所属的可用区 ID。

cn-hangzhou-g
ScalingConfigurationIdstring

关联伸缩配置的 ID。

asc-bp1i65jd06v04vdh****
Entrustedboolean

手动添加实例到伸缩组时,是否将实例托管给伸缩组,托管状态的手动添加实例,在移除伸缩组(不包括手动移除)时,将执行释放操作。可能值:

  • true:将实例托管给伸缩组。
  • false:不将实例托管给伸缩组。
true
WeightedCapacityinteger

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

4
CreatedTimestring

ECS 实例加入伸缩组的时间,精确到秒。

2020-05-18T03:11:39Z
ScalingActivityIdstring

ECS 实例加入伸缩组时,伸缩活动的 ID。

asa-bp1c9djwrgxjyk31****
ScalingInstanceIdstring

伸缩组内的实例标识,与 ECS 实例或 ECI 实例的 ID 一一对应。

asi-j6cj1gcte640ekhb****
PrivateIpAddressstring

伸缩组中实例的内网 IP 地址。

1**.2*.1**.2**

示例

正常返回示例

JSON格式

{
  "RequestId": "B13527BF-1FBD-4334-A512-20F5E9D3FB4D",
  "PageSize": 10,
  "PageNumber": 1,
  "TotalSpotCount": 4,
  "TotalCount": 1,
  "ScalingInstances": [
    {
      "CreationTime": "2020-05-18T03:11Z",
      "LoadBalancerWeight": 50,
      "LaunchTemplateId": "lt-m5e3ofjr1zn1aw7****",
      "InstanceId": "i-bp109k5j3dum1ce6****",
      "SpotStrategy": "SpotWithPriceLimit",
      "LaunchTemplateVersion": "1",
      "HealthStatus": "Healthy",
      "ScalingGroupId": "asg-bp1igpak5ft1flyp****",
      "WarmupState": "NoNeedWarmup",
      "LifecycleState": "InService",
      "CreationType": "AutoCreated",
      "ZoneId": "cn-hangzhou-g",
      "ScalingConfigurationId": "asc-bp1i65jd06v04vdh****",
      "Entrusted": true,
      "WeightedCapacity": 4,
      "CreatedTime": "2020-05-18T03:11:39Z",
      "ScalingActivityId": "asa-bp1c9djwrgxjyk31****",
      "ScalingInstanceId": "asi-j6cj1gcte640ekhb****",
      "PrivateIpAddress": "1**.2*.1**.2**"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-11-14OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:LifecycleStates
出参OpenAPI 返回结构发生变更
2023-11-03OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-07-19OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:CreationTypes
  • 本页导读 (1)
文档反馈