查询后端云服务器
功能介绍
查询指定后端云服务器组的后端云服务器。支持过滤查询和分页查询。如未特殊说明, 匹配规则为精确匹配。
接口约束
分页查询使用的参数为marker、limit、page_reverse。marker和page_reverse只有和limit一起使用时才会生效,单独使用无效。
URI
GET /v2.0/lbaas/pools/{pool_id}/members
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
pool_id |
是 |
String |
后端云服务器组ID。 |
请求消息
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
marker |
否 |
String |
分页查询的起始的资源ID,表示上一页最后一条查询记录的后端云服务器的ID。不指定时表示查询第一页。 必须与limit一起使用。 |
limit |
否 |
Integer |
分页查询每页的后端云服务器个数。如果不设置,则默认不分页查询所有后端云服务器。 |
page_reverse |
否 |
Boolean |
分页的顺序,true表示从后往前分页,false表示从前往后分页,默认为false。 必须与limit一起使用。 |
id |
否 |
String |
后端云服务器的ID。
说明:
此处并非服务器的ID,而是ELB为绑定的后端服务器自动生成的memberID。 |
tenant_id |
否 |
String |
后端云服务器所属的项目ID。 支持的最大字符长度:255 |
name |
否 |
String |
后端云服务器的名称。 支持的最大字符长度:255 |
address |
否 |
String |
后端云服务器对应的IP地址。 支持的最大字符长度:64 |
protocol_port |
否 |
Integer |
后端云服务器后端端口的协议号。 |
subnet_id |
否 |
String |
后端云服务器所在的子网ID。 |
admin_state_up |
否 |
Boolean |
后端云服务器的管理状态。 取值范围:true/false。
说明:
该字段虽然支持创建、更新,但实际取值决定于后端云服务器对应的弹性云服务器是否存在。若存在,该值为true,否则,该值为false。 |
weight |
否 |
Integer |
后端云服务器的权重。 |
响应消息
参数 |
参数类型 |
描述 |
---|---|---|
members |
Array |
属于某个后端云服务器组的后端云服务器对象列表。对象详见表4。 |
members_links |
Array |
后端云服务器的分页查询中上下页的链接信息。 仅当分页查询时响应体中有该字段。详见表5。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
后端云服务器的 ID。
说明:
此处并非服务器的ID,而是ELB为绑定的后端服务器自动生成的memberID。 |
tenant_id |
String |
后端云服务器所在的项目ID。 支持的最大字符长度:255 |
name |
String |
后端云服务器的名称。 支持的最大字符长度:255 |
address |
String |
后端云服务器对应的IP地址,该IP必须在subnet_id字段指定子网的网段中,例如192.168.3.11。 只能对应主网卡的IP。 支持的最大字符长度:64 |
protocol_port |
Integer |
后端端口和协议号,取值范围[1,65535]。 |
subnet_id |
String |
后端云服务器所在的子网ID。后端云服务器的IP地址在该子网的网段中。 不支持开启了ipv6的子网。 |
admin_state_up |
Boolean |
后端云服务器的管理状态:true/false。 只支持指定为true。
说明:
该字段虽然支持创建、更新,但实际取值决定于后端云服务器对应的弹性云服务器是否存在。若存在,该值为true,否则,该值为false。 |
weight |
Integer |
后端云服务器的权重,取值范围[0,100]。 权重为0的后端不再接受新的请求。默认为1。 |
operating_status |
String |
后端云服务器的健康状态,取值:
|
请求示例
- 请求样例1 全量查询后端云服务器
GET https://{Endpoint}/v2.0/lbaas/pools/5a9a3e9e-d1aa-448e-af37-a70171f2a332/members
- 请求样例2 过滤查询IP为10.0.0.8且端口为80的后端云服务器
GET https://{Endpoint}/v2.0/lbaas/pools/5a9a3e9e-d1aa-448e-af37-a70171f2a332/members?address=10.0.0.8&protocol_port=80
响应示例
- 响应样例1
{ "members": [ { "address": "10.0.0.8", "admin_state_up": true, "id": "9a7aff27-fd41-4ec1-ba4c-3eb92c629313", "protocol_port": 80, "subnet_id": "013d3059-87a4-45a5-91e9-d721068ae0b2", "tenant_id": "1a3e005cf9ce40308c900bcb08e5320c", "weight": 1, "operating_status": "ONLINE", "name": "member-name" } ] }
- 响应样例2
{ "members": [ { "address": "10.0.0.8", "admin_state_up": true, "id": "9a7aff27-fd41-4ec1-ba4c-3eb92c629313", "protocol_port": 80, "subnet_id": "013d3059-87a4-45a5-91e9-d721068ae0b2", "tenant_id": "1a3e005cf9ce40308c900bcb08e5320c", "weight": 1, "operating_status": "ONLINE", "name": "member-name" } ] }
返回码
请参见负载均衡返回码说明。