文档首页/ 弹性伸缩 AS/ API参考/ API/ 弹性伸缩组/ 查询弹性伸缩组详情 - ShowScalingGroup
更新时间:2026-09-30 GMT+08:00
分享

查询弹性伸缩组详情 - ShowScalingGroup

功能介绍

根据伸缩组ID查询指定弹性伸缩组详情。

调试

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

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

URI

GET /autoscaling-api/v1/{project_id}/scaling_group/{scaling_group_id}

表1 参数说明

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。获取方式请参见获取项目ID。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

scaling_group_id

是

String

参数解释:

伸缩组ID。获取方式请参见查询弹性伸缩组列表 - ListScalingGroups。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

无

请求示例

查询ID为d4e50321-3777-4135-97f8-9f5e9714a4b0的伸缩组详情。

GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/d4e50321-3777-4135-97f8-9f5e9714a4b0

响应消息

表2 响应参数

参数

参数类型

描述

scaling_group

scaling_groups object

参数解释:

伸缩组详情。具体请参见表3

表3 scaling_groups字段数据结构说明

参数

参数类型

描述

scaling_group_name

String

参数解释:

伸缩组名称。

取值范围:

1-64个字符,只能包含中文、字母、数字、下划线或中划线。

scaling_group_id

String

参数解释:

伸缩组ID。

取值范围:

不涉及

scaling_group_status

String

参数解释:

伸缩组状态。

取值范围:

  • INSERVICE:正常状态
  • PAUSED:停用状态
  • ERROR:异常状态
  • DELETING:删除中
  • FREEZED:已冻结

scaling_configuration_id

String

参数解释:

伸缩配置ID。

取值范围:

不涉及

scaling_configuration_name

String

参数解释:

伸缩配置名称。

取值范围:

1-64个字符,只能包含中文、字母、数字、下划线或中划线。

current_instance_number

Integer

参数解释:

伸缩组中当前实例数。

取值范围:

不涉及

desire_instance_number

Integer

参数解释:

伸缩组中期望实例数。

取值范围:

不涉及

min_instance_number

Integer

参数解释:

伸缩组中最小实例数。

取值范围:

不涉及

max_instance_number

Integer

参数解释:

伸缩组中最大实例数。

取值范围:

0-300的整数。

cool_down_time

Integer

参数解释:

冷却时间,单位是秒。

取值范围:

0-86400秒。

lb_listener_id

String

参数解释:

经典型负载均衡监听器ID,多个负载均衡监听器ID以逗号分隔。

取值范围:

不涉及

lbaas_listeners

Array of lbaas_listeners objects

参数解释:

增强型负载均衡器信息,详情请见表4 lbaas_listeners字段数据结构说明。

available_zones

Array of strings

参数解释:

可用区信息。弹性伸缩活动中自动添加的云服务器会被创建在指定的可用区中。如果没有指定可用区,会由系统自动指定可用区。详情请参考地区和终端节点。

networks

Array of networks objects

参数解释:

网络信息,详情请见表5 networks字段数据结构说明

security_groups

Array of security_groups objects

参数解释:

安全组信息,详情请见表8 security_groups字段数据结构说明

create_time

String

参数解释:

创建伸缩组时间,遵循UTC时间。

取值范围:

不涉及

vpc_id

String

参数解释:

伸缩组所在的VPC ID。

取值范围:

不涉及

detail

String

参数解释:

伸缩组详情。当伸缩活动失败时,在此处记录错误信息。

取值范围:

不涉及

is_scaling

Boolean

参数解释:

伸缩组伸缩标志。

取值范围:

不涉及

health_periodic_audit_method

String

参数解释:

健康检查方式。

取值范围:

ELB_AUDIT和NOVA_AUDIT。

  • ELB_AUDIT:负载均衡健康检查方式,在有监听器的伸缩组中有效。
  • NOVA_AUDIT:云服务器健康检查方式,是弹性伸缩自带的健康检查方式。

health_periodic_audit_time

Integer

参数解释:

健康检查的间隔时间,单位为分钟。

取值范围:

可设置为1、5、15、60、180(分钟),若设置为0,可以实现10秒级健康检查。

health_periodic_audit_grace_period

Integer

参数解释:

健康状况检查宽限期,单位为秒。

取值范围:

0-86400秒。

instance_terminate_policy

String

参数解释:

移除策略。

取值范围:

  • OLD_CONFIG_OLD_INSTANCE(默认):从“较早创建的配置”创建的实例中选择较早创建的实例进行优先移除。
  • OLD_CONFIG_NEW_INSTANCE:从“较早创建的配置”创建的实例中选择较晚创建的实例进行优先移除。
  • OLD_INSTANCE:较早创建的实例被优先移除。
  • NEW_INSTANCE:较晚创建的实例将被优先移除。

delete_publicip

Boolean

参数解释:

删除云服务器是否删除云服务器绑定的弹性IP。

取值范围:

  • true:删除云服务器时,会同时删除绑定在云服务器上的弹性IP。
  • false:删除云服务器时,仅解绑定在云服务器上的弹性IP,不删除弹性IP。

delete_volume

Boolean

参数解释:

删除云服务器是否删除云服务器绑定的数据盘。

取值范围:

  • true:删除云服务器时,会同时删除绑定在云服务器上的数据盘。当数据盘的计费方式为包年包月时,不会被删除。
  • false:删除云服务器时,仅解绑定在云服务器上的数据盘,不删除数据盘。

cloud_location_id

String

参数解释:

伸缩组所属cloud_location,该参数为预留字段。

取值范围:

不涉及

enterprise_project_id

String

参数解释:

企业项目ID

取值范围:

  • 取值为0或无该值,表示属于default企业项目。
  • 取值为UUID,表示属于该UUID对应的企业项目。

activity_type

String

参数解释:

伸缩组活动类型。

取值范围:

  • NORMAL:普通伸缩活动
  • MANNUAL_REMOVE:从伸缩组手动移除实例
  • MANNUAL_DELETE:从伸缩组手动移除并删除实例
  • MANNUAL_ADD:实例手动加入伸缩组。
  • ELB_CHECK_DELETE:ELB检查移除并删除实例。
  • AUDIT_CHECK_DELETE:通过审计移除并删除实例。
  • DIFF:期望实例数与实际实例数不一致。
  • MODIFY_ELB:ELB迁移。
  • ENTER_STANDBY:实例转入备用。
  • EXIT_STANDBY:实例移出备用。

multi_az_priority_policy

String

参数解释:

伸缩组扩缩容时目标AZ选择的优先级策略。

取值范围:

  • EQUILIBRIUM_DISTRIBUTE(默认):均衡分布,云服务器扩缩容时优先保证available_zones列表中各AZ下虚拟机数量均衡,当无法在目标AZ下完成虚拟机扩容时,按照PICK_FIRST原则选择其他可用AZ。
  • PICK_FIRST:选择优先,虚拟机扩缩容时目标AZ的选择按照available_zones列表的顺序进行优先级排序。

description

String

参数解释:

伸缩组描述。

取值范围:

1-256个字符。

iam_agency_name

String

参数解释:

委托的名称。委托是由租户管理员在统一身份认证服务(Identity and Access Management,IAM)上创建的,可以为弹性云服务器提供访问云服务的临时凭证。

取值范围:

1-64个字符

tags

Array of tags objects

参数解释:

添加到伸缩组的标签。详情请见表9 tags字段数据结构说明

表4 lbaas_listeners字段数据结构说明

参数

参数类型

描述

listener_id

String

参数解释:

监听器ID

取值范围:

不涉及

pool_id

String

参数解释:

后端服务器组ID。如何获取请参见查询后端服务器组列表。

取值范围:

不涉及

protocol_port

Integer

参数解释:

后端协议号,指后端云服务器监听的端口。

取值范围:

[1, 65535]

weight

Integer

参数解释:

权重,指后端云服务器经分发得到的请求数量的比例。

取值范围:

[0, 100]

protocol_version

String

参数解释:

绑定到负载均衡云服务器组的IP地址版本。

取值范围:

  • ipv4:表示使用IPv4地址版本。
  • ipv6:表示使用IPv6地址版本。
表5 networks字段数据结构说明

参数

参数类型

描述

id

String

参数解释:

子网的网络ID。

取值范围:

不涉及

ipv6_enable

Boolean

参数解释:

是否启用IPv6。

取值范围:

true:表示此网卡已启用ipv6。

false:表示此网卡未启用ipv6。

ipv6_bandwidth

ipv6_bandwidth object

参数解释:

绑定的IPv6共享带宽,默认为空,表示不绑定IPv6的共享带宽。

allowed_address_pairs

Array of allowed_address_pairs objects

参数解释:

是否开启源/目的检查开关。详情请参见表7。

表6 ipv6_bandwidth字段数据结构说明

参数

参数类型

描述

id

String

参数解释:

IPv6共享带宽的ID。

取值范围:

不涉及

表7 allowed_address_pairs字段数据结构说明

参数

参数类型

描述

ip_address

String

参数解释:

IP地址,用于控制源/目的检查开关的开启状态。默认是开启,不允许置空。

取值范围:

  • 关闭:1.1.1.1/0
  • 开启:除“1.1.1.1/0”以外的其余值均按开启处理
表8 security_groups字段数据结构说明

参数

参数类型

描述

id

String

参数解释:

安全组ID

取值范围:

不涉及

表9 tags字段数据结构说明

参数

是否必选

参数类型

描述

key

是

String

参数解释:

键。

取值范围:

  • 最大长度36个unicode字符。key不能为空。
  • 同一资源的key值不能重复。
  • 只能包含大写字母(A~Z)、小写字母(a~z)、数字(0-9)、下划线(_)、中划线(-)以及中文字符。

value

否

String

参数解释:

值。

取值范围:

  • 每个值最大长度43个unicode字符,可以为空字符串。
  • value值只能包含大写字母(A~Z)、小写字母(a~z)、数字(0-9)、下划线(_)、中划线(-)、小数点(.)以及中文字符。

响应示例

{
    "scaling_group": {
      "networks": [
                {
                    "id": "a8327883-6b07-4497-9c61-68d03ee193a",
                    "ipv6_enable": true,
                    "ipv6_bandwidth": 
                        {         
                              "id": "076ee2ff-f23e-4338-b8ac-1bc7278532d5"
                        }
                }
        ],
        "available_zones": [
               "XXXa",
               "XXXb"
        ],
        "detail": null,
        "scaling_group_name": "api_gateway_modify",
        "scaling_group_id": "d4e50321-3777-4135-97f8-9f5e9714a4b0",
        "scaling_group_status": "INSERVICE",
        "scaling_configuration_id": "53579851-3841-418d-a97b-9cecdb663a90",
        "scaling_configuration_name": "press",
        "current_instance_number": 7,
        "desire_instance_number": 8,
        "min_instance_number": 0,
        "max_instance_number": 100,
        "cool_down_time": 900,
        "lb_listener_id": null,
        "security_groups": [
            {
                "id": "23b7b999-0a30-4b48-ae8f-ee201a88a6ab"
            }
        ],
        "create_time": "2015-09-01T08:36:10Z",
        "vpc_id": "3e22f934-800d-4bb4-a588-0b9a76108190",
        "health_periodic_audit_method": "NOVA_AUDIT",
        "health_periodic_audit_time": 5,
        "health_periodic_audit_grace_period": 600,
        "instance_terminate_policy": "OLD_CONFIG_OLD_INSTANCE",
        "is_scaling": true,
        "delete_publicip": false,
        "enterprise_project_id":"c92b1a5d-6f20-43f2-b1b7-7ce35e58e413",
        "activity_type":"MODIFY_ELB",
        "multi_az_priority_policy":"PICK_FIRST",        "iam_agency_name":"test",
        "tags":[{"key":"1"}]
    }
}

返回值

  • 正常

    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

    网关超时。

错误码

请参考错误码。

相关文档