查询后端服务器列表

project_id

是

String

参数解释：项目ID。

pool_id

是

String

参数解释：后端服务器组ID。

marker

否

String

上一页最后一条记录的ID。

使用说明：

• 必须与limit一起使用。

• 不指定时表示查询第一页。

• 该字段不允许为空或无效的ID。

limit

否

Integer

参数解释：每页返回的个数。

取值范围：0-2000

默认取值：2000

page_reverse

否

Boolean

是否反向查询。

取值：

• true：查询上一页。

• false：查询下一页，默认。

使用说明：

• 必须与limit一起使用。

• 当page_reverse=true时，若要查询上一页，marker取值为当前页返回值的previous_marker。

name

否

Array of strings

后端服务器名称。

支持多值查询，查询条件格式：name=xxx&name=xxx。

weight

否

Array of integers

后端服务器的权重，请求将根据pool配置的负载均衡算法和后端服务器的权重进行负载分发。

权重值越大，分发的请求越多。权重为0的后端不再接受新的请求。

取值：0-100。

支持多值查询，查询条件格式：weight=xxx&weight=xxx。

admin_state_up

否

Boolean

后端服务器的管理状态。

取值：true、false。

虽然创建、更新请求支持该字段，但实际取值决定于后端服务器对应的弹性云服务器是否存在。若存在，该值为true，否则，该值为false。

subnet_cidr_id

否

Array of strings

后端服务器所在子网的IPv4子网ID或IPv6子网ID。

支持多值查询，查询条件格式：**subnet_cidr_id=xxx&subnet_cidr_id=xxx。

address

否

Array of strings

后端服务器对应的IPv4或IPv6地址。

支持多值查询，查询条件格式：address=xxx&address=xxx。

protocol_port

否

Array of integers

后端服务器业务端口号。

支持多值查询，查询条件格式：protocol_port=xxx&protocol_port=xxx。

id

否

Array of strings

后端服务器ID。

支持多值查询，查询条件格式：id=xxx&id=xxx。

operating_status

否

Array of strings

后端服务器的健康状态。

取值：

• ONLINE：后端服务器正常。

• NO_MONITOR：后端服务器所在的服务器组没有健康检查器。

• OFFLINE：后端服务器关联的ECS服务器不存在或已关机。

支持多值查询，查询条件格式：operating_status=xxx&operating_status=xxx。

enterprise_project_id

否

Array of strings

参数解释：所属的企业项目ID。

如果enterprise_project_id不传值，默认查询所有企业项目下的资源，鉴权按照细粒度权限鉴权，必须在用户组下分配elb:*list权限。

如果enterprise_project_id传值，鉴权按照企业项目权限鉴权，分为传入具体eps_id和all_granted_eps两种场景，前者查询指定eps_id的eps下的资源，后者查询的是所有有list权限的eps下的资源。

支持多值查询，查询条件格式：

enterprise_project_id=xxx&enterprise_project_id=xxx。

ip_version

否

Array of strings

当前后端服务器的IP地址版本。取值：v4、v6。

member_type

否

Array of strings

后端服务器的类型。

取值：

• ip：跨VPC的member。

• instance：关联到ECS的member。

支持多值查询，查询条件格式：member_type=xxx&member_type=xxx。

instance_id

否

Array of strings

member关联的ECS实例ID，空表示跨VPC场景的member。

支持多值查询，查询条件格式：instance_id=xxx&instance_id=xxx。

X-Auth-Token

是

String

参数解释：IAM鉴权Token

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。

name

String

参数解释：后端服务器名称。

注意：该名称并非ECS名称。

project_id

String

参数解释：后端服务器所在的项目ID。

admin_state_up

Boolean

参数解释：后端服务器的管理状态。

约束限制：虽然创建、更新请求支持该字段，但实际取值决定于后端服务器对应的弹性云服务器是否存在。若存在，该值为true，否则，该值为false。

取值范围：true、false。

subnet_cidr_id

String

参数解释：后端服务器所在的子网，可以是IPv4或IPv6子网。若是IPv4子网，使用对应子网的子网ID（neutron_subnet_id）；若是IPv6子网，使用对应子网的网络ID（neutron_network_id）。

ipv4子网的子网ID可以通过GET

https://{VPC_Endpoint}/v1/{project_id}/subnets

响应参数中的neutron_subnet_id得到

ipv6子网的网络ID可以通过GET

https://{VPC_Endpoint}/v1/{project_id}/subnets

响应参数中的neutron_network_id得到

约束限制：

• 该子网和关联的负载均衡器的子网必须在同一VPC下。

• 若所属LB的跨VPC后端转发特性已开启，则该字段可以不传，表示添加跨VPC的后端服务器。此时address必须为IPv4地址，所在的pool的协议必须为UDP/TCP/TLS/HTTP/HTTPS/QUIC/GRPC。

protocol_port

Integer

参数解释：后端服务器业务端口。

weight

Integer

参数解释：后端服务器的权重，请求将根据pool配置的负载均衡算法和后端服务器的权重进行负载分发。

权重值越大，分发的请求越多。权重为0的后端不再接受新的请求。

约束限制：若所在pool的lb_algorithm取值为SOURCE_IP或QUIC_CID，该字段无效。

取值范围：0-100

默认取值：1。

address

String

参数解释：后端服务器对应的IP地址。

约束限制：

• 若subnet_cidr_id为空，表示添加跨VPC后端，此时address必须为IPv4地址。

• 若subnet_cidr_id不为空，表示是一个关联到ECS的后端服务器。该IP地址可以是私网IPv4或IPv6。

  但必须在subnet_cidr_id对应的子网网段中。

ip_version

String

参数解释：当前后端服务器的IP地址版本，由后端系统自动根据传入的address字段确定。

取值范围：v4、v6。

operating_status

String

参数解释：后端服务器的健康状态。当status非空时，以status字段中监听器粒度的健康检查状态优先。

取值范围：

• ONLINE：后端服务器正常。

• NO_MONITOR：后端服务器所在的服务器组没有健康检查器。

• OFFLINE：后端服务器关联的ECS服务器不存在或已关机。

reason

MemberHealthCheckFailedReason object

健康检查异常的原因。

status

Array of MemberStatus objects

参数解释：后端服务器监听器粒度的的健康状态。

约束限制：

• 若绑定的监听器在该字段中，则以该字段中监听器对应的operating_stauts为准。

• 若绑定的监听器不在该字段中，则以外层的operating_status为准。

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

参数解释：后端服务器的类型。

取值范围：

• ip：跨VPC的member。

• instance：关联到ECS的member。

instance_id

String

参数解释：member关联的实例ID。空表示member关联的实例为非真实设备 （如：跨VPC场景）

listener_id

String

参数解释：监听器ID

operating_status

String

参数解释：后端服务器的健康状态。

取值范围：

• ONLINE：后端服务器正常。

• NO_MONITOR：后端服务器所在的服务器组没有健康检查器。

• OFFLINE：后端服务器关联的ECS服务器不存在或已关机。

reason

MemberHealthCheckFailedReason object

健康检查异常的原因。

reason_code

String

健康检查异常原因码.

取值：

• CONNECT_TIMEOUT: 负载均衡健康检查时向后端服务器建立连接超时。

• CONNECT_REFUSED: 负载均衡健康检查时向后端服务器拒绝连接。

• CONNECT_FAILED: 负载均衡健康检查时向后端服务器建立连接失败。

• CONNECT_INTERRUPT: 负载均衡健康检查与后端服务器连接中断。

• SSL_HANDSHAKE_ERROR: 负载均衡健康检查时与后端服务器SSL握手失败。

• RECV_RESPONSE_FAILED: 负载均衡健康检查时从后端服务器接收响应失败。

• RECV_RESPONSE_TIMEOUT: 负载均衡健康检查时从后端服务器接收响应超时。

• SEND_REQUEST_FAILED: 负载均衡健康检查时向后端服务器发送请求失败。

• SEND_REQUEST_TIMEOUT: 负载均衡健康检查时向后端服务器发送请求超时。

• RESPONSE_FORMAT_ERROR: 负载均衡健康检查时从后端服务器接收响应格式错误。

• RESPONSE_MISMATCH: 负载均衡健康检查时从后端服务器接收的响应码与预期配置返回码不一致。

expected_response

String

健康检查预期响应状态码。

支持HTTP,HTTPS,GRPC健康检查。

只有reason_code为RESPONSE_MISMATCH时，支持非null取值。

取值：

• 单值：单个返回码。当type为GRPC时，取值范围为0-99；当type为其他协议时，取值范围为200-599。例如："0"或"200"。

• 列表：多个特定返回码，逗号分隔，最多支持5个返回码。例如:"200,202"或"0,1"。

• 区间：一个返回码区间，区间内"-"分隔，区间之间逗号分隔，最多支持5个区间。例如"200-204,300-399"或"0-5,10-12,20-30"。

healthcheck_response

String

健康检查探测响应状态码。

支持HTTP,HTTPS,GRPC健康检查。

只有reason_code为RESPONSE_MISMATCH时，支持非null取值。

取值：

• 单个返回码。当type为GRPC时，取值范围为0-99；当type为其他协议时，取值范围为200-599。例如："0"或"200"。

200

操作正常返回。