# 查询后端云服务器组 #### 功能介绍 查询后端云服务器组列表。支持过滤查询和分页查询。如未特殊说明，匹配规则为精确匹配。 #### 接口约束 分页查询使用的参数为marker、limit、page_reverse。marker和page_reverse只有和limit一起使用时才会生效，单独使用无效。 #### URI GET /v2.0/lbaas/pools #### 请求消息 表1请求参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | marker | 否 | String | 分页查询的起始的资源ID，表示上一页最后一条查询记录的后端云服务器组的ID。不指定时表示查询第一页。 必须与limit一起使用。 | | limit | 否 | Integer | 分页查询每页的后端云服务器组个数。 | | page_reverse | 否 | Boolean | 分页的顺序，true表示从后往前分页，false表示从前往后分页，默认为false。 必须与limit一起使用。 | | id | 否 | String | 后端云服务器组ID。 | | tenant_id | 否 | String | 后端云服务器组所属的项目ID。 获取方法详见[获取项目ID](https://support.huaweicloud.com/api-elb/elb_fl_0008.html)。 支持的最大字符长度：255 | | project_id | 否 | String | 此参数和tenant_id参数含义一样，均指后端云服务器组所属的项目ID。 获取方法详见[获取项目ID](https://support.huaweicloud.com/api-elb/elb_fl_0008.html)。 | | name | 否 | String | 后端云服务器组名称。 支持的最大字符长度：255 | | description | 否 | String | 后端云服务器组的描述信息。 支持的最大字符长度：255 | | healthmonitor_id | 否 | String | 后端云服务器组关联的健康检查的ID。 | | loadbalancer_id | 否 | String | 后端云服务器组关联的负载均衡器ID。 | | protocol | 否 | String | 后端云服务器组的后端协议。 支持TCP、UDP和HTTP。 | | lb_algorithm | 否 | String | 后端云服务器组的负载均衡算法。 取值范围： - ROUND_ROBIN：加权轮询算法。 - LEAST_CONNECTIONS：加权最少连接算法。 - SOURCE_IP：源IP算法。 当该字段的取值为SOURCE_IP时，后端云服务器组绑定的后端云服务器的[weight字段](https://support.huaweicloud.com/api-elb/elb_zq_hd_0003.html#elb_zq_hd_0003__zh-cn_topic_0049139656_table63335993)无效。 | | member_address | 否 | String | 后端云服务器组关联的后端云服务器IP。 | | member_device_id | 否 | String | 后端云服务器组关联的后端云服务器对应的弹性云服务器的ID。 | #### 响应消息 表2响应参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | pools | Array | 后端云服务器组对象列表。详见[表3]。 | | pools_links | List | 后端云服务器组的分页查询中上下页的链接信息。 仅当分页查询时响应体中有该字段。详见[表8] | 表3pools字段说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 后端云服务器组ID。 | | tenant_id | String | 后端云服务器组所属的项目 ID。 支持的最大字符长度：255 | | project_id | String | 此参数和tenant_id参数含义一样，均指后端云服务器组所属的项目 ID。 | | name | String | 后端云服务器组名称。 支持的最大字符长度：255 | | description | String | 后端云服务器组的描述信息。 支持的最大字符长度：255 | | protocol | String | 后端云服务器组的后端协议。 支持TCP、UDP和HTTP。 | | lb_algorithm | String | 后端云服务器组的负载均衡算法。 取值范围： - ROUND_ROBIN：加权轮询算法。 - LEAST_CONNECTIONS：加权最少连接算法。 - SOURCE_IP：源IP算法。 当该字段的取值为SOURCE_IP时，后端云服务器组绑定的后端云服务器的weight字段无效。 | | members | Array | 后端云服务器组关联的后端云服务器ID的列表。 | | healthmonitor_id | String | 后端云服务器组关联的健康检查的ID。 | | admin_state_up | Boolean | 后端云服务器组的管理状态。 该字段为预留字段，暂未启用。取值范围：true/false。 - true表示开启。 - false表示关闭。 | | listeners | Array | 后端云服务器组关联的监听器ID的列表。 | | loadbalancers | String | 后端云服务器组关联的负载均衡器ID的列表。 | | session_persistence | Object | 后端云服务器组的会话持久性。详见[表7]。 当开启会话保持后，在一定时间内，来自同一客户端的请求会发送到同一个后端云服务器上。 取值范围：当会话保持关闭时，该字段取值为null。 | 表4members字段说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 关联的后端服务器id | 表5listeners字段说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 关联的后端服务器组id | 表6loadbalancers字段说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 关联的负载均衡器id | 表7session_persistence字段说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | 会话保持的类型。 取值范围： - SOURCE_IP：根据请求的源IP，将同一IP的请求发送到同一个后端云服务器上。 - HTTP_COOKIE：客户端第一次发送请求时，负载均衡器自动生成cookie并将该cookie插入响应消息中，后续请求会发送到处理第一个请求的后端云服务器上。 - APP_COOKIE：客户端第一次发送请求时，后端服务器生成cookie并将该cookie插入响应消息中，后续请求会发送到处理第一个请求的后端云服务器上。 当后端云服务器组的protocol为TCP时，只按SOURCE_IP生效；当后端云服务器组的protocol为HTTP时，只按HTTP_COOKIE、APP_COOKIE生效。 | | cookie_name | String | cookie名称。 当会话保持类型是APP_COOKIE时，为必选字段，其它类型时不可指定。 | | persistence_timeout | Integer | 会话保持的超时时间。 当type为APP_COOKIE时不生效。 - 取值范围： - \[1,60\]（分钟）：当后端云服务器组的protocol为TCP、UDP时。 - \[1,1440\]（分钟）：当后端云服务器组的protocol为HTTP、HTTPS时。 | 表8pools_links字段说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | href | String | 后端云服务器组的分页查询中上下页的url。 | | rel | String | 上下页的提示信息，取值： - next：表示href是下一页的URL - previous：表示href是上一页的url | #### 请求样例 - 请求样例1 分页查询后端云服务器组 ``` GET https://{Endpoint}/v2.0/lbaas/pools?limit=2 ``` - 请求样例2 过滤查询负载均衡算法为SOURCE_IP的后端云服务器组 ``` GET https://{Endpoint}/v2.0/lbaas/pools?lb_algorithm=SOURCE_IP ``` #### 响应样例 - 响应样例1 ``` { "pools": [ { "lb_algorithm": "SOURCE_IP", "protocol": "TCP", "description": "", "admin_state_up": true, "loadbalancers": [ { "id": "07d28d4a-4899-40a3-a939-5d09d69019e1" } ], "tenant_id": "1867112d054b427e808cc6096d8193a1", "project_id": "1867112d054b427e808cc6096d8193a1", "session_persistence": null, "healthmonitor_id": null, "listeners": [ { "id": "1b421c2d-7e78-4a78-9ee4-c8ccba41f15b" } ], "members": [ { "id": "88f9c079-29cb-435a-b98f-0c5c0b90c2bd" }, { "id": "2f4c9644-d5d2-4cf8-a3c0-944239a4f58c" } ], "id": "3a9f50bb-f041-4eac-a117-82472d8a0007", "name": "my-pool" } ], "pools_links": [ { "href": "https://{Endpoint}/v2.0/lbaas/pools?limit=2&marker=0469a5ad-6233-4669-8d38-5920f2bd95b6", "rel": "next" }, { "href": "https://{Endpoint}/v2.0/lbaas/pools?limit=2&marker=02d43e35-e874-4139-bdba-d65609db20ab&page_reverse=True", "rel": "previous" } ] } ``` - 响应样例2 ``` { "pools": [ { "lb_algorithm": "SOURCE_IP", "protocol": "TCP", "description": "", "admin_state_up": true, "loadbalancers": [ { "id": "07d28d4a-4899-40a3-a939-5d09d69019e1" } ], "tenant_id": "1867112d054b427e808cc6096d8193a1", "project_id": "1867112d054b427e808cc6096d8193a1", "session_persistence": null, "healthmonitor_id": null, "listeners": [ { "id": "1b421c2d-7e78-4a78-9ee4-c8ccba41f15b" } ], "members": [ { "id": "88f9c079-29cb-435a-b98f-0c5c0b90c2bd" }, { "id": "2f4c9644-d5d2-4cf8-a3c0-944239a4f58c" } ], "id": "3a9f50bb-f041-4eac-a117-82472d8a0007", "name": "my-pool" } ] } ``` #### 返回码 请参见[状态码](https://support.huaweicloud.com/api-elb/elb_gc_1102.html)。