查询弹性伸缩组列表

功能介绍

根据输入条件过滤查询弹性伸缩组列表。查询结果分页显示。

• 可根据伸缩组名称，伸缩配置ID，伸缩组状态，起始行号，记录条数进行条件过滤查询。
• 若不加过滤条件默认最多查询租户下20条伸缩组信息。

URI

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

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

请求消息

• 请求参数

  无

• 请求样例
  示例为查询满足条件“伸缩组名称为as-group-test且伸缩配置ID为1d281494-6085-4579-b817-c1f813be835f”的伸缩组列表。

  GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group?scaling_group_name=as-group-test&scaling_configuration_id=1d281494-6085-4579-b817-c1f813be835f

响应消息

• 响应参数

  表2 响应参数

  参数	参数类型	描述
  total_number	Integer	总记录数。
  start_number	Integer	查询的开始记录号。
  limit	Integer	查询记录数。
  scaling_groups	Array	伸缩组列表。

  表3 scaling_groups字段数据结构说明

  参数	参数类型	描述
  scaling_group_name	String	伸缩组名称。
  scaling_group_id	String	伸缩组ID。
  scaling_group_status	String	伸缩组状态。
  scaling_configuration_id	String	伸缩配置ID。
  scaling_configuration_name	String	伸缩配置名称。
  current_instance_number	Integer	伸缩组中当前实例数。
  desire_instance_number	Integer	伸缩组中期望实例数。
  min_instance_number	Integer	伸缩组中最小实例数。
  max_instance_number	Integer	伸缩组中最大实例数。
  cool_down_time	Integer	冷却时间，单位是秒。
  lbaas_listeners	Array	增强型负载均衡器信息，详情请见表 lbaas_listeners字段数据结构说明。
  available_zones	Array	可用区信息。
  networks	Array	网络信息，详情请见表5
  security_groups	Array	安全组信息，详情请见表7
  create_time	String	创建伸缩组时间，遵循UTC时间。
  vpc_id	String	伸缩组所在的VPC ID。
  detail	String	伸缩组详情。当伸缩活动失败时，在此处记录错误信息。
  is_scaling	Boolean	伸缩组伸缩标志。
  health_periodic_audit_method	String	健康检查方式。
  health_periodic_audit_time	Integer	健康检查的间隔时间。
  health_periodic_audit_grace_period	Integer	健康状况检查宽限期。
  instance_terminate_policy	String	移除策略。
  notifications	Array	通知方式： EMAIL为发送邮件通知。
  delete_publicip	Boolean	删除云服务器是否删除云服务器绑定的弹性IP。
  delete_volume	Boolean	删除云服务器是否删除云服务器绑定的数据盘。
  cloud_location_id	String	该参数为预留字段。
  activity_type	String	伸缩组活动类型。
  multi_az_priority_policy	String	伸缩组扩缩容时目标AZ选择的优先级策略。

  表4 lbaas_listeners字段数据结构说明

  参数	参数类型	描述
  listener_id	String	监听器ID
  pool_id	String	后端云服务器组ID
  protocol_port	Integer	后端协议号，指后端云服务器监听的端口。
  weight	Integer	权重，指后端云服务器经分发得到的请求数量的比例。

  表5 networks字段数据结构说明

  参数	参数类型	描述
  id	String	网络ID
  ipv6_enable	Boolean	是否启用IPv6。取值为true时，标识此网卡已启用ipv6。默认取值为false。
  ipv6_bandwidth	Object	绑定的IPv6共享带宽，默认为空，表示不绑定IPv6的共享带宽。

  表6 ipv6_bandwidth字段数据结构说明

  参数	参数类型	描述
  id	String	IPv6共享带宽的ID。

  表7 security_groups字段数据结构说明

  参数	参数类型	描述
  id	String	安全组ID

• 响应样例

  {
      "limit": 20,
      "scaling_groups": [
          {
              "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": "as-group-test",
              "scaling_group_id": "77a7a397-7d2f-4e79-9da9-6a35e2709150",
              "scaling_group_status": "INSERVICE",
              "scaling_configuration_id": "1d281494-6085-4579-b817-c1f813be835f",
              "scaling_configuration_name": "healthCheck",
              "current_instance_number": 0,
              "desire_instance_number": 1,
              "min_instance_number": 0,
              "max_instance_number": 500,
              "cool_down_time": 300,
              "lb_listener_id": "f06c0112570743b51c0e8fbe1f235bab",
              "security_groups": [
                  {
                      "id": "8a4b1d5b-0054-419f-84b1-5c8a59ebc829"
                  }
              ],
              "create_time": "2015-07-23T02:46:29Z",
              "vpc_id": "863ccae2-ee85-4d27-bc5b-3ba2a198a9e2",
              "health_periodic_audit_method": "ELB_AUDIT",
              "health_periodic_audit_time": 5,
              "health_periodic_audit_grace_period": 600,
              "instance_terminate_policy": "OLD_CONFIG_OLD_INSTANCE",
              "is_scaling": false,
              "delete_publicip": false
              "multi_az_priority_policy": "PICK_FIRST"
          }
      ],
      "total_number": 1,
      "start_number": 0
  }

返回值

• 正常

  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	网关超时。

错误码

请参考错误码。