查询后端服务器列表
功能介绍
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。 |
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得到 约束限制:
|
protocol_port |
Integer |
参数解释:后端服务器业务端口。 说明:
在开启端口透传的pool下创建member传该字段不生效,可不传该字段。 |
weight |
Integer |
参数解释:后端云服务器的权重,请求将根据pool配置的负载均衡算法和后端云服务器的权重进行负载分发。 权重值越大,分发的请求越多。权重为0的后端不再接受新的请求。 约束限制:若所在pool的lb_algorithm取值为SOURCE_IP,该字段无效。 取值范围:0-100 默认取值:1。 |
address |
String |
参数解释:后端服务器对应的IP地址。 约束限制:
|
ip_version |
String |
参数解释:当前后端服务器的IP地址版本,由后端系统自动根据传入的address字段确定。 取值范围:v4、v6。 |
operating_status |
String |
参数解释:后端云服务器的健康状态。当status非空时,以status字段中监听器粒度的健康检查状态优先。 取值范围:
|
status |
Array of MemberStatus objects |
参数解释:后端云服务器监听器粒度的的健康状态。 约束限制:
|
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" }
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
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("<YOUR REGION>")) .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()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
# 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("<YOUR REGION>")) \ .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) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := elb.NewElbClient( elb.ElbClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) 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的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
操作正常返回。 |
错误码
请参见错误码。