云主机 > API 文档 > 弹性伸缩 >查询伸缩组列表

查询伸缩组列表

最近更新时间: 2021-12-22 19:58:16

请求路径

GET /v1/ess/group

请求参数

名称	类型	位置	是否必须	描述
region_id	string	query	否	支持多个地域 ID, 按逗号分隔
scaling_group_name	string	query	否	伸缩组名称，支持模糊搜索
scaling_group_id	string	query	否	伸缩组 ID
page	int	query	否	页码
size	int	query	否	分页大小

返回值

名称	类型	是否必须	描述
data	[]ScalingGroup	是	伸缩组列表
request_id	string	是	请求记录 ID
page	int	是	页码
size	int	是	分页大小
total	int	是	查询到的总数

ScalingGroup 伸缩组详情

名称	类型	是否必须	描述
region_id	string	是	地域 ID
scaling_group_id	string	是	伸缩组 ID
scaling_group_name	string	是	伸缩组名称
lifecycle_state	string	是	伸缩组的状态信息。取值范围：Active 生效状态, Inactive 失效状态，Deleting 伸缩组正在删除。
min_size	int	是	伸缩组内ECS实例台数的最小值。
max_size	int	是	伸缩组内ECS实例台数的最大值。
default_cooldown	int	是	伸缩组默认的冷却时间。冷却时间内，该伸缩组不执行其它的伸缩活动。
created_at	string	是	创建时间
updated_at	string	是	更新时间
removal_policies	[]string	是	ECS实例移出伸缩组的策略的集合。取值范围：OldestInstance (取最早创建的 ECS 实例), NewestInstance (取最新创建的实例), OldestScalingConfiguration (取最早伸缩配置创建的 ECS 实例)。
total_capacity	int	是	当伸缩组设置了实例规格权重，表示伸缩组内所有ECS实例的加权容量总和。否则，表示伸缩组内所有ECS实例的数量。
active_capacity	int	是	已成功加入伸缩组，并正常运行的ECS实例数量。
pending_capacity	int	是	正在加入伸缩组，还未完成相关配置的ECS实例的数量。
removing_capacity	int	是	正在移出伸缩组的ECS实例的数量。
v_switch_ids	[]string	是	伸缩组关联虚拟交换机的ID集合。
health_check_type	string	是	伸缩组的健康检查方式。取值范围：NONE (不做健康检查), ECS (对伸缩组内的ECS实例做健康检查)。

示例

正常返回示例

{
    "data": [
        {
            "uid": 1810751266,
            "scaling_group_id": "asg-m5eic8p33ac0rqzankrw",
            "scaling_group_name": "伸缩组fzot",
            "region_id": "cn-qingdao",
            "lifecycle_state": "Inactive",
            "min_size": 0,
            "max_size": 10,
            "default_cooldown": 300,
            "removal_policies": [
                "OldestScalingConfiguration",
                "OldestInstance"
            ],
            "total_capacity": 0,
            "active_capacity": 0,
            "pending_capacity": 0,
            "removing_capacity": 0,
            "v_switch_id": "vsw-m5e1p78bbr17ksglttvur",
            "v_switch_ids": [
                "vsw-m5e1p78bbr17ksglttvur"
            ],
            "creation_time": "2020-09-28T09:10Z",
            "health_check_type": "ECS",
            "updated_at": "2020-09-28T17:10:53.077+08:00",
            "created_at": "2020-09-28T17:10:45.779+08:00"
        }
    ],
    "page": 1,
    "size": 20,
    "total": 1,
    "request_id": "504ce405-58d1-40b1-9674-40d7d3875d65"
}

以上内容是否对您有帮助？