查询后端服务器列表
功能介绍
Pool下的后端服务器列表。
接口约束
-
分页查询使用的参数为marker、limit、page_reverse。
-
marker和page_reverse只有和limit一起使用时才会生效,单独使用无效。
调用方法
请参见如何调用API。
URI
GET /v3/{project_id}/elb/pools/{pool_id}/members
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。 |
pool_id |
是 |
String |
后端服务器组ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
marker |
否 |
String |
上一页最后一条记录的ID。 使用说明:
|
limit |
否 |
Integer |
每页返回的个数。 最小值:0 最大值:2000 缺省值:2000 |
page_reverse |
否 |
Boolean |
是否反向查询。 取值:
使用说明:
|
name |
否 |
Array |
后端云服务器名称。 支持多值查询,查询条件格式:name=xxx&name=xxx。 |
weight |
否 |
Array |
后端云服务器的权重,请求将根据pool配置的负载均衡算法和后端云服务器的权重进行负载分发。 权重值越大,分发的请求越多。权重为0的后端不再接受新的请求。 取值:0-100。 支持多值查询,查询条件格式:weight=xxx&weight=xxx。 |
admin_state_up |
否 |
Boolean |
后端云服务器的管理状态。 取值:true、false。 虽然创建、更新请求支持该字段,但实际取值决定于后端云服务器对应的弹性云服务器是否存在。若存在,该值为true,否则,该值为false。 |
subnet_cidr_id |
否 |
Array |
后端云服务器所在子网的IPv4子网ID或IPv6子网ID。 支持多值查询,查询条件格式:**subnet_cidr_id=xxx&subnet_cidr_id=xxx。 |
address |
否 |
Array |
后端服务器对应的IPv4或IPv6地址。 支持多值查询,查询条件格式:address=xxx&address=xxx。 |
protocol_port |
否 |
Array |
后端服务器业务端口号。 支持多值查询,查询条件格式:protocol_port=xxx&protocol_port=xxx。 |
id |
否 |
Array |
后端云服务器ID。 支持多值查询,查询条件格式:id=xxx&id=xxx。 |
operating_status |
否 |
Array |
后端云服务器的健康状态。 取值:
支持多值查询,查询条件格式:operating_status=xxx&operating_status=xxx。 |
enterprise_project_id |
否 |
Array |
企业项目ID。不传时查询default企业项目"0"下的资源,鉴权按照default企业项目鉴权; 如果传值,则传已存在的企业项目ID或all_granted_eps(表示查询所有企业项目)进行查询。 支持多值查询,查询条件格式:enterprise_project_id=xxx&enterprise_project_id=xxx。 |
ip_version |
否 |
Array |
当前后端服务器的IP地址版本。取值:v4、v6。 |
member_type |
否 |
Array |
后端云服务器的类型。 取值:
支持多值查询,查询条件格式:member_type=xxx&member_type=xxx。 |
instance_id |
否 |
Array |
member关联的ECS实例ID,空表示跨VPC场景的member。 支持多值查询,查询条件格式:instance_id=xxx&instance_id=xxx。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
IAM鉴权Token |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
request_id |
String |
请求ID。 注:自动生成 。 |
page_info |
PageInfo object |
分页信息。 |
members |
Array of Member objects |
后端服务器对象列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
previous_marker |
String |
分页查询结果中第一条记录的ID。通常用于配合page_reverse=true查询上一页。 |
next_marker |
String |
分页查询结果中最后一条记录的ID。通常用于查询下一页。 |
current_count |
Integer |
当前的记录数。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
后端服务器ID。
说明:
说明: 此处并非ECS服务器的ID,而是ELB为绑定的后端服务器自动生成的member ID。 |
name |
String |
后端服务器名称。注意:该名称并非ECS名称。 |
project_id |
String |
后端服务器所在的项目ID。 |
pool_id |
String |
所在后端服务器组ID。 不支持该字段,请勿使用。 |
admin_state_up |
Boolean |
后端云服务器的管理状态。 取值:true、false。 虽然创建、更新请求支持该字段,但实际取值决定于后端云服务器对应的弹性云服务器是否存在。若存在,该值为true,否则,该值为false。 |
subnet_cidr_id |
String |
后端云服务器所在子网的IPv4子网ID或IPv6子网ID。 若所属的LB的跨VPC后端转发特性已开启,则该字段可以不传,表示添加跨VPC的后端服务器。 此时address必须为IPv4地址,所在的pool的协议必须为TCP/HTTP/HTTPS。 使用说明:该子网和关联的负载均衡器的子网必须在同一VPC下。 |
protocol_port |
Integer |
后端服务器业务端口。
说明:
在开启端口透传的pool下创建member传该字段不生效,可不传该字段。 最小值:1 最大值:65535 |
weight |
Integer |
后端云服务器的权重,请求将根据pool配置的负载均衡算法和后端云服务器的权重进行负载分发。 权重值越大,分发的请求越多。权重为0的后端不再接受新的请求。 取值:0-100,默认1。 使用说明:若所在pool的lb_algorithm取值为SOURCE_IP,该字段无效。 最小值:0 最大值:100 |
address |
String |
后端服务器对应的IP地址。 使用说明:
|
ip_version |
String |
当前后端服务器的IP地址版本,由后端系统自动根据传入的address字段确定。取值:v4、v6。 |
device_owner |
String |
设备所有者。 取值:
不支持该字段,请勿使用。 |
device_id |
String |
关联的ECS ID,为空表示后端服务器未关联到ECS。 不支持该字段,请勿使用。 |
operating_status |
String |
后端云服务器的健康状态。当status非空时,以status字段中监听器粒度的健康检查状态优先。 取值:
|
status |
Array of MemberStatus objects |
后端云服务器监听器粒度的的健康状态。 若绑定的监听器在该字段中,则以该字段中监听器对应的operating_stauts为准。 若绑定的监听器不在该字段中,则以外层的operating_status为准。 |
loadbalancer_id |
String |
所属负载均衡器ID。 不支持该字段,请勿使用。 |
loadbalancers |
Array of ResourceID objects |
后端云服务器关联的负载均衡器ID列表。 不支持该字段,请勿使用。 |
created_at |
String |
创建时间。格式:yyyy-MM-dd'T'HH:mm:ss'Z',UTC时区。 注意:独享型实例的历史数据以及共享型实例下的资源,不返回该字段。 |
updated_at |
String |
更新时间。格式:yyyy-MM-dd'T'HH:mm:ss'Z',UTC时区。 注意:独享型实例的历史数据以及共享型实例下的资源,不返回该字段。 |
member_type |
String |
后端云服务器的类型。 取值:
|
instance_id |
String |
member关联的实例ID。空表示member关联的实例为非真实设备 (如:跨VPC场景) |
请求示例
查询后端服务器列表
GET https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/pools/36ce7086-a496-4666-9064-5ba0e6840c75/members
响应示例
状态码: 200
操作正常返回。
{ "members" : [ { "name" : "quark-neutron", "weight" : 100, "admin_state_up" : false, "subnet_cidr_id" : "c09f620e-3492-4429-ac15-445d5dd9ca74", "project_id" : "99a3fff0d03c428eac3678da6a7d0f24", "address" : "120.10.10.2", "protocol_port" : 2100, "id" : "0aa23a52-1ac2-4a2d-8dfa-1e11cb26079d", "operating_status" : "NO_MONITOR", "ip_version" : "v4" }, { "name" : "quark-neutron", "weight" : 100, "admin_state_up" : false, "subnet_cidr_id" : "c09f620e-3492-4429-ac15-445d5dd9ca74", "project_id" : "99a3fff0d03c428eac3678da6a7d0f24", "address" : "120.10.10.2", "protocol_port" : 2101, "id" : "315b928b-39e4-4d5f-8e48-39e9108c1035", "operating_status" : "NO_MONITOR", "ip_version" : "v4" }, { "name" : "quark-neutron", "weight" : 100, "admin_state_up" : false, "subnet_cidr_id" : "27e4ab69-a5ed-46c6-921a-5212be19ce87", "project_id" : "99a3fff0d03c428eac3678da6a7d0f24", "address" : "2001:db8:a583:6a::4", "protocol_port" : 2101, "id" : "53976f72-d2aa-47f5-baf4-4906ed6b42d6", "operating_status" : "NO_MONITOR", "ip_version" : "v6" } ], "page_info" : { "previous_marker" : "0aa23a52-1ac2-4a2d-8dfa-1e11cb26079d", "current_count" : 3 }, "request_id" : "87e29592-7ab8-401a-9bf4-66cf6747eab9" }
状态码
状态码 |
描述 |
---|---|
200 |
操作正常返回。 |
错误码
请参见错误码。