调用DescribeScalingInstances,通过伸缩组ID查询该伸缩组内的ECS实例列表及实例信息,包括当前伸缩组中,运行状态的抢占式实例总数、ECS实例总数、ECS实例的预热状态、生命周期状态等。同时也支持指定实例健康状态、生命周期状态、创建方式等筛选符合要求的ECS实例。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ess:DescribeScalingInstances | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 伸缩组所属地域的 ID。 | cn-hangzhou |
ScalingGroupId | string | 否 | 伸缩组的 ID。 | asg-bp1igpak5ft1flyp**** |
ScalingConfigurationId | string | 否 | 关联伸缩配置的 ID。 | asc-bp1i65jd06v04vdh**** |
HealthStatus | string | 否 | ECS 实例在伸缩组中的健康状态,未处于运行中(Running)状态的 ECS 实例会被判定为不健康的 ECS 实例,取值范围:
弹性伸缩会自动移出伸缩组中不健康的 ECS 实例,并释放自动创建的 ECS 实例。 是否释放手动添加的 ECS 实例由其托管状态决定。如果实例生命周期未托管给伸缩组,只移出实例但不释放。如果实例生命周期托管给伸缩组,移出并释放实例。 说明
请确保账号可用额度充足。如果账号欠费,所有后付费的 ECS 实例(包括按量付费实例和抢占式实例)都会停机,甚至被释放。欠费后伸缩组内 ECS 实例状态变化,请参见欠费说明。
| Healthy |
LifecycleState | string | 否 | ECS 实例在伸缩组中的生命周期状态,取值范围:
| InService |
CreationType | string | 否 | 伸缩组中实例的创建方式,取值范围:
| AutoCreated |
PageNumber | integer | 否 | ECS 实例列表的页码,起始值:1。 默认值:1。 | 1 |
PageSize | integer | 否 | 分页查询时设置的每页行数,最大值:100。 默认值:10。 | 10 |
ScalingActivityId | string | 否 | 伸缩活动的 ID。 | asa-bp1c9djwrgxjyk31**** |
InstanceIds | array | 否 | ECS 实例的 ID。 返回查询结果时忽略失效的 InstanceId,并且不报错。 | |
string | 否 | ECS 实例的 ID。 返回查询结果时忽略失效的 InstanceId,并且不报错。 | i-bp109k5j3dum1ce6**** | |
CreationTypes | array | 否 | 伸缩组中实例的创建方式,此参数和 CreationType 参数只能同时传入一个。 | |
string | 否 | 伸缩组中实例的创建方式,可分为 AutoCreated、Attached、Managed。 | AutoCreated | |
LifecycleStates | array | 否 | ECS 实例在伸缩组中的生命周期状态列表,此参数和 LifecycleState 参数只能同时传入一个,建议您使用此参数。 | |
string | 否 | ECS 实例在伸缩组中的生命周期状态,取值范围:
| InService |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "B13527BF-1FBD-4334-A512-20F5E9D3****",
"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-14 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-11-03 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-07-19 | OpenAPI 入参发生变更 | 查看变更详情 |