文档首页> 弹性伸缩 AS> API参考> API> 弹性伸缩实例> 查询弹性伸缩组中的实例列表
更新时间:2022-07-29 GMT+08:00
分享

查询弹性伸缩组中的实例列表

功能介绍

根据输入条件过滤查询弹性伸缩组中实例信息。查询结果分页显示。

  • 可根据实例在伸缩组中的生命周期状态,实例健康状态,实例保护状态,起始行号,记录条数进行条件过滤查询。
  • 若不加过滤条件默认查询组内最多20条实例信息。

调试

您可以在API Explorer中调试该接口。

URI

GET /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/list

可以在URI后面用‘?’和‘&’添加不同的查询条件组合。支持参数说明中所有非必选参数过滤,请参考请求样例。

表1 参数说明

参数

是否必选

参数类型

描述

project_id

String

项目ID。

scaling_group_id

String

伸缩组ID。

life_cycle_state

String

实例在伸缩组中的生命周期状态:

  • INSERVICE:已启用
  • PENDING:正在加入伸缩组
  • PENDING_WAIT:等待(正在加入伸缩组)
  • REMOVING:正在移出伸缩组
  • REMOVING_WAIT:等待(正在移出伸缩组)
  • STANDBY:已备用
  • ENTERING_STANDBY:进入备用状态

health_status

String

实例健康状态:

  • INITIALIZING:初始化
  • NORMAL:正常
  • ERROR:异常

protect_from_scaling_down

String

实例保护状态:

  • true:已设置实例保护。
  • false:未设置实例保护。

start_number

Integer

查询的起始行号,默认为0。最小值为0。

limit

Integer

查询的记录条数,默认为20。取值范围为:0~100。

请求消息

  • 请求参数

  • 请求样例
    本示例展示了查询ID为e5d27f5c-dd76-4a61-b4bc-a67c5686719a的伸缩组下已启用且处于健康状态的实例。
    GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_instance/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/list?life_cycle_state=INSERVICE&health_status=NORMAL

响应消息

  • 响应参数
    表2 响应参数

    参数

    参数类型

    描述

    total_number

    Integer

    总记录数

    start_number

    Integer

    查询的起始行号

    limit

    Integer

    查询记录数

    scaling_group_instances

    Array of scaling_group_instances objects

    伸缩组实例详情

    表3 scaling_group_instances字段数据结构说明

    参数

    参数类型

    描述

    instance_id

    String

    实例ID

    instance_name

    String

    实例名称

    scaling_group_id

    String

    实例所在伸缩组ID

    scaling_group_name

    String

    实例所在伸缩组名称。

    支持模糊匹配。

    life_cycle_state

    String

    实例在伸缩组中的生命周期状态:

    • INSERVICE:已启用
    • PENDING:正在加入伸缩组
    • PENDING_WAIT:等待(正在加入伸缩组)
    • REMOVING:正在移出伸缩组
    • REMOVING_WAIT:等待(正在移出伸缩组)
    • STANDBY:已备用
    • ENTERING_STANDBY:进入备用状态

    health_status

    String

    实例健康状态:

    • INITAILIZING:初始化。
    • NORMAL:正常。
    • ERROR:错误。

    scaling_configuration_name

    String

    伸缩配置名称。

    scaling_configuration_id

    String

    伸缩配置ID。

    若返回不为空,表示该实例为弹性伸缩自动创建的ECS实例。

    若返回为空,表示该实例为用户手动添加到伸缩组的ECS实例。

    create_time

    String

    实例加入伸缩组时间,遵循UTC时间。

    protect_from_scaling_down

    Boolean

    实例的实例保护属性。

  • 响应样例
    {
        "limit": 10,
        "total_number": 1,
        "start_number": 0,
        "scaling_group_instances": [
            {
                "instance_id": "b25c1589-c96c-465b-9fef-d06540d1945c",
                "scaling_group_id": "e5d27f5c-dd76-4a61-b4bc-a67c5686719a",
                "scaling_group_name": "discuz",
                "life_cycle_state": "INSERVICE",
                "health_status": "NORMAL",
                "scaling_configuration_name": "discuz",
                "scaling_configuration_id": "ca3dcd84-d197-4c4f-af2a-cf8ba39696ac",
                "create_time": "2015-07-23T06:47:33Z",
                "instance_name": "discuz_3D210808",
                "protect_from_scaling_down": false
            }
        ]
    }

返回值

  • 正常

    200

  • 异常

    返回值

    说明

    400 Bad Request

    服务器未能处理请求。

    401 Unauthorized

    被请求的页面需要用户名和密码。

    403 Forbidden

    对被请求的页面访问禁止。

    404 Not Found

    服务器无法找到被请求的页面。

    405 Method Not Allowed

    请求中指定的方法不被允许。

    406 Not Acceptable

    服务器生成的响应无法被客户端所接受。

    407 Proxy Authentication Required

    用户必须首先使用代理服务器进行验证,这样请求才会被处理。

    408 Request Timeout

    请求超出了服务器的等待时间。

    409 Conflict

    由于冲突,请求无法被完成。

    500 Internal Server Error

    请求未完成。服务异常。

    501 Not Implemented

    请求未完成。服务器不支持所请求的功能。

    502 Bad Gateway

    请求未完成。服务器从上游服务器收到一个无效的响应。

    503 Service Unavailable

    请求未完成。系统暂时异常。

    504 Gateway Timeout

    网关超时。

错误码

请参考错误码

分享:

    相关文档

    相关产品

close