# 查询后端服务器列表 - ListMembers #### 功能介绍 Pool下的后端服务器列表。 #### 接口约束 - 分页查询使用的参数为marker、limit、page_reverse。 - marker和page_reverse只有和limit一起使用时才会生效，单独使用无效。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-elb/elb_dy_0000.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-elb/elb_sq_0001.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | elb:members:list | List | pool | - | - | - | | elb:members:list | List | member \* | - | - | - | | elb:members:list | List | - | g:EnterpriseProjectId | - | - | #### URI GET /v3/{project_id}/elb/pools/{pool_id}/members 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释** ：项目ID。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-elb/elb_fl_0008.html)。 **约束限制**：不涉及 **取值范围**：长度为32个字符，由小写字母和数字组成。 **默认取值**：不涉及 | | pool_id | 是 | String | **参数解释**：后端服务器组ID。 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | marker | 否 | String | **参数解释**：上一页最后一条记录的ID。 **约束限制**： - 必须与limit一起使用。 - 不指定时表示查询第一页。 - 该字段不允许为空或无效的ID。 **取值范围**：不涉及 **默认取值**：不涉及 | | limit | 否 | Integer | **参数解释**：每页返回的个数。 **约束限制**：不涉及 **取值范围**：0-2000 **默认取值**：2000 | | page_reverse | 否 | Boolean | **参数解释**：是否反向查询。 **约束限制**： - 必须与limit一起使用。 - 当page_reverse=true时，若要查询上一页，marker取值为当前页返回值的previous_marker。 **取值范围**： - true：查询上一页。 - false：查询下一页。 **默认取值**：false | | name | 否 | Array of strings | **参数解释**：后端服务器名称。注意：该名称并非ECS名称。 支持多值查询，查询条件格式：*name=xxx\&name=xxx*。 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及 | | weight | 否 | Array of integers | **参数解释**：后端服务器的权重，请求将根据pool配置的负载均衡算法和后端服务器的权重进行负载分发。 权重值越大，分发的请求越多。权重为0的后端不再接受新的请求。 支持多值查询，查询条件格式：*weight=xxx\&weight=xxx*。 **约束限制**：不涉及 **取值范围**：0-100 **默认取值**：不涉及 | | admin_state_up | 否 | Boolean | **参数解释**：后端服务器的管理状态。 **约束限制**：不涉及 **取值范围**：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 | **参数解释**：后端服务器的健康状态。 支持多值查询，查询条件格式：*operating_status=xxx\&operating_status=xxx*。 **约束限制**：不涉及 **取值范围**： - NO_MONITOR：后端服务器所在的服务器组没有开启健康检查。 - INITIAL：初始化中，表示负载均衡实例配置了健康检查，但查不到数据。 - ONLINE：后端服务器正常。 - OFFLINE：后端服务器关联的ECS服务器不存在或已关机。 - UNKNOWN：未关联LB实例的pool下的member，或者创建后从未关联ECS的云服务器类型member，状态置为UNKNOWN。 **默认取值**：不涉及 | | enterprise_project_id | 否 | Array of strings | **参数解释**：资源所属的企业项目ID。 支持多值查询，查询条件格式：*enterprise_project_id=xxx\&enterprise_project_id=xxx*。 **约束限制**： - 如果enterprise_project_id不传值，默认查询所有企业项目下的资源，鉴权按照细粒度权限鉴权，必须在用户组下分配elb:members:list权限。 - 如果enterprise_project_id传值，鉴权按照企业项目权限鉴权，分为传入具体eps_id和all_granted_eps两种场景，前者查询指定eps_id的eps下的资源，后者查询的是所有有list权限的eps下的资源。 **取值范围**：不涉及 **默认取值**：不涉及 | | ip_version | 否 | Array of strings | **参数解释**：当前后端服务器的IP地址版本。 **约束限制**：不涉及 **取值范围**：v4、v6。 **默认取值**：不涉及 | | member_type | 否 | Array of strings | **参数解释**：后端服务器的类型。 支持多值查询，查询条件格式：*member_type=xxx\&member_type=xxx*。 **约束限制**：不涉及 **取值范围**： - ip：跨VPC的member。 - instance：关联到ECS的member。 **默认取值**：不涉及 | | instance_id | 否 | Array of strings | **参数解释**：member关联的ECS实例ID，空表示跨VPC场景的member。 支持多值查询，查询条件格式：*instance_id=xxx\&instance_id=xxx*。 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及 | | availability_zone | 否 | Array of strings | **参数解释**：后端服务器的可用区。 支持多值查询，查询条件格式：*availability_zone=xxx\&availability_zone=xxx*。 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**：IAM鉴权Token。 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | request_id | String | **参数解释**：请求ID。 **取值范围**：由数字、小写字母和中划线（-）组成的字符串，自动生成。 | | page_info | [PageInfo] object | **参数解释**：分页信息。 | | members | Array of [Member] objects | **参数解释**：后端服务器对象列表。 | 表5PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | previous_marker | String | **参数解释**：分页查询结果中第一条记录的ID。通常用于配合page_reverse=true查询上一页。 **取值范围**：不涉及 | | next_marker | String | **参数解释**：分页查询结果中最后一条记录的ID。通常用于查询下一页。 **取值范围**：不涉及 | | current_count | Integer | **参数解释**：当前页返回记录数。 **取值范围**：不涉及 | 表6Member | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**：后端服务器ID。 **取值范围**：不涉及 说明： 此处并非ECS服务器的ID，而是ELB为绑定的后端服务器自动生成的member ID。 | | availability_zone | String | **参数解释**：后端服务器所在的可用区。 **取值范围**：不涉及 | | name | String | **参数解释**：后端服务器名称。 **取值范围**：不涉及 注意：该名称并非ECS名称。 | | project_id | String | **参数解释**：后端服务器所在的项目ID。 **取值范围**：不涉及 | | admin_state_up | Boolean | **参数解释**：后端服务器的管理状态。 **取值范围**：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得到 **取值范围**：不涉及 | | protocol_port | Integer | **参数解释**：后端服务器业务端口。 **取值范围**：不涉及 说明： 在开启端口透传的pool下创建member传该字段不生效，可不传该字段。 | | weight | Integer | **参数解释**：后端服务器的权重，请求将根据pool配置的负载均衡算法和后端服务器的权重进行负载分发。 权重值越大，分发的请求越多。权重为0的后端不再接受新的请求。 **取值范围**：0-100 | | address | String | **参数解释**：后端服务器对应的IP地址。 **取值范围**：不涉及 | | ip_version | String | **参数解释**：当前后端服务器的IP地址版本，由后端系统自动根据传入的address字段确定。 **取值范围**：v4、v6 | | operating_status | String | **参数解释**：后端服务器的健康状态。当status非空时，以status字段中监听器粒度的健康检查状态优先。 **取值范围**： - NO_MONITOR：后端服务器所在的服务器组没有开启健康检查。 - INITIAL：初始化中，表示负载均衡实例配置了健康检查，但查不到数据。 - ONLINE：后端服务器正常。 - OFFLINE：后端服务器关联的ECS服务器不存在或已关机。 - UNKNOWN：未关联LB实例的pool下的member，或者创建后从未关联ECS的云服务器类型member，状态置为UNKNOWN。 | | status | Array of [MemberStatus] objects | **参数解释**：后端服务器监听器粒度的健康状态。 **取值范围**：不涉及 | | reason | [MemberHealthCheckFailedReason] object | **参数解释**：健康检查异常的原因。 | | 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：IP类型的member。 - instance：关联到ECS的member。 | | instance_id | String | **参数解释**：member关联的实例ID。空表示member关联的实例为非真实设备 （如：跨VPC场景） **取值范围**：不涉及 | 表7MemberStatus | 参数 | 参数类型 | 描述 | |:---|:---|:---| | listener_id | String | **参数解释**：监听器ID **取值范围**：不涉及 | | operating_status | String | **参数解释**：后端服务器的健康状态。 **取值范围**： - ONLINE：后端服务器正常。 - NO_MONITOR：后端服务器所在的服务器组没有健康检查器。 - OFFLINE：后端服务器关联的ECS服务器不存在或已关机。 - INITIAL：后端云服务器健康检查打开时的初始状态。 - UNKNOWN: 后端云服务器组没有绑定监听器或者后端云服务器没有关联ECS等原因，后端云服务器健康检查结果未知。 | | reason | [MemberHealthCheckFailedReason] object | **参数解释**：后端服务器的健康状态。 | | created_at | String | **参数解释**：创建时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。 **取值范围**：不涉及 | | updated_at | String | **参数解释**：更新时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。 **取值范围**：不涉及 | 表8MemberHealthCheckFailedReason | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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"。 | #### 请求示例 查询后端服务器列表 ``` 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", "availability_zone" : "az1" }, { "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", "availability_zone" : "az2" }, { "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", "availability_zone" : "az2" } ], "page_info" : { "previous_marker" : "0aa23a52-1ac2-4a2d-8dfa-1e11cb26079d", "current_count" : 3 }, "request_id" : "87e29592-7ab8-401a-9bf4-66cf6747eab9" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.elb.v3.region.ElbRegion; import com.huaweicloud.sdk.elb.v3.*; import com.huaweicloud.sdk.elb.v3.model.*; public class ListMembersSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); ElbClient client = ElbClient.newBuilder() .withCredential(auth) .withRegion(ElbRegion.valueOf("")) .build(); ListMembersRequest request = new ListMembersRequest(); request.withPoolId("{pool_id}"); try { ListMembersResponse response = client.listMembers(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkelb.v3.region.elb_region import ElbRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkelb.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = ElbClient.new_builder() \ .with_credentials(credentials) \ .with_region(ElbRegion.value_of("")) \ .build() try: request = ListMembersRequest() request.pool_id = "{pool_id}" response = client.list_members(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" elb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := elb.ElbClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := elb.NewElbClient(hcClient) request := &model.ListMembersRequest{} request.PoolId = "{pool_id}" response, err := client.ListMembers(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ELB/sdk?api=ListMembers&version=v3)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 操作正常返回。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-elb/ErrorCode.html)。