更新时间:2024-10-28 GMT+08:00
分享

后端服务器全局列表

功能介绍

查询当前项目下的后端服务器列表。

接口约束

分页查询使用的参数为marker、limit、page_reverse。

marker和page_reverse只有和limit一起使用时才会生效,单独使用无效。

调用方法

请参见如何调用API

URI

GET /v3/{project_id}/elb/members

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:项目ID。

表2 Query参数

参数

是否必选

参数类型

描述

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

后端服务器的权重,请求按权重在同一后端服务器组下的后端服务器间分发。

权重为0的后端不再接受新的请求。

当后端服务器所在的后端服务器组的lb_algorithm的取值为SOURCE_IP时,该字段无效。

支持多值查询,查询条件格式:weight=xxx&weight=xxx

admin_state_up

Boolean

后端服务器的管理状态;该字段虽然支持创建、更新,但实际取值决定于member对应的弹性云服务器是否存在。

若存在,该值为true,否则,该值为false。

subnet_cidr_id

Array of strings

后端服务器所在的子网ID。该子网和后端服务器关联的负载均衡器的子网必须在同一VPC下。只支持指定IPv4的子网ID。

支持多值查询,查询条件格式:**subnet_cidr_id=xxx&subnet_cidr_id=xxx

address

Array of strings

后端服务器的对应的IP地址,这个IP必须在subnet_cidr_id字段的子网网段中。

例如:192.168.3.11。

支持多值查询,查询条件格式: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,已下线。

支持多值查询,查询条件格式:operating_status=xxx&operating_status=

enterprise_project_id

Array of strings

企业项目ID。不传时查询default企业项目"0"下的资源,鉴权按照default企业项目鉴权;

如果传值,则传已存在的企业项目ID或all_granted_eps(表示查询所有企业项目)进行查询。

支持多值查询,查询条件格式:

enterprise_project_id=xxx&enterprise_project_id=xxx

ip_version

Array of strings

IP版本,取值v4、v6。

支持多值查询,查询条件格式:ip_version=xxx&ip_version=xxx

pool_id

Array of strings

member所属的服务器组ID

支持多值查询,查询条件格式:pool_id=xxx&pool_id=xxx

loadbalancer_id

Array of strings

member所属的负载均衡器ID。

支持多值查询,查询条件格式:loadbalancer_id=xxx&loadbalancer_id=xxx

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:IAM鉴权Token。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

request_id

String

请求ID。

注:自动生成 。

page_info

PageInfo object

分页信息。

members

Array of MemberInfo objects

后端服务器对象列表。

表5 PageInfo

参数

参数类型

描述

previous_marker

String

参数解释:分页查询结果中第一条记录的ID。通常用于配合page_reverse=true查询上一页。

next_marker

String

参数解释:分页查询结果中最后一条记录的ID。通常用于查询下一页。

current_count

Integer

参数解释:当前的记录数。

表6 MemberInfo

参数

参数类型

描述

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或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

后端服务器业务端口。

说明:

在开启端口透传的pool下创建member传该字段不生效,可不传该字段。

weight

Integer

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

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

取值:0-100,默认1。

使用说明:若所在pool的lb_algorithm取值为SOURCE_IP或QUIC_CID,该字段无效。

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。

device_owner

String

设备所有者。

取值:

  • 空,表示后端服务器未关联到ECS。

  • compute:{az_name},表示关联到ECS,其中{az_name}表示ECS所在可用区名。

  • compute:subeni,表示辅助弹性网卡。

不支持该字段,请勿使用。

device_id

String

关联的ECS ID,为空表示后端服务器未关联到ECS。

不支持该字段,请勿使用。

operating_status

String

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

取值:

  • ONLINE:后端服务器正常。

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

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

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

后端服务器的类型。

取值:

  • ip:跨VPC的member。

  • instance:关联到ECS的member。

instance_id

String

member关联的实例ID。空表示member关联的实例为非真实设备 (如:跨VPC场景)

表7 MemberStatus

参数

参数类型

描述

listener_id

String

参数解释:监听器ID

operating_status

String

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

取值范围:

  • ONLINE:后端服务器正常。

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

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

表8 ResourceID

参数

参数类型

描述

id

String

资源ID

请求示例

查询当前项目下的所有后端服务器列表

GET https://{ELB_Endpoint}/v3/7a9941d34fc1497d8d0797429ecfd354/elb/members

响应示例

状态码: 200

操作正常返回。

{
  "request_id" : "9bd54b2c-b6c6-4635-9495-dd89bdd917ad",
  "members" : [ {
    "name" : "member-1",
    "weight" : 1,
    "admin_state_up" : true,
    "project_id" : "86f9bb15ce80442680229fcd4dc96582",
    "address" : "192.168.0.157",
    "protocol_port" : 80,
    "id" : "f5e20309-c79c-470c-b59c-3c8378792897",
    "operating_status" : "ONLINE",
    "status" : [ {
      "listener_id" : "0663b12d-4a8f-4ee1-8ba2-dd09f2c92ef7",
      "operating_status" : "ONLINE"
    }, {
      "listener_id" : "19ac6a54-336f-44ce-9679-50c4f56e9407",
      "operating_status" : "ONLINE"
    } ],
    "instance_id" : "39b7d471-fbb4-4e6d-ac81-635b4415a27f",
    "device_id" : "39b7d471-fbb4-4e6d-ac81-635b4415a27f",
    "device_owner" : "compute:cn-southwest-242a",
    "member_type" : "instance",
    "created_at" : "2023-05-04T06:55:33Z",
    "updated_at" : "2023-05-08T01:34:02Z",
    "loadbalancer_id" : "9eafbe79-4d48-46f6-95e6-0bc3da57b96d",
    "loadbalancers" : [ {
      "id" : "9eafbe79-4d48-46f6-95e6-0bc3da57b96d"
    } ],
    "pool_id" : "46cd9381-3d99-4e32-b799-efaf5c274586",
    "ip_version" : "v4",
    "subnet_cidr_id" : "1aee2ab8-f238-4c26-8659-2a7a0c201d0a"
  }, {
    "name" : "member-2",
    "admin_state_up" : true,
    "project_id" : "86f9bb15ce80442680229fcd4dc96582",
    "address" : "192.168.0.157",
    "protocol_port" : 80,
    "id" : "f834d6c6-b376-4031-931e-57cb36bca4a8",
    "operating_status" : "OFFLINE",
    "status" : [ ],
    "instance_id" : "39b7d471-fbb4-4e6d-ac81-635b4415a27f",
    "device_id" : "39b7d471-fbb4-4e6d-ac81-635b4415a27f",
    "device_owner" : "compute:cn-southwest-242a",
    "member_type" : "instance",
    "created_at" : "2023-05-04T12:46:55Z",
    "updated_at" : "2023-05-05T03:56:40Z",
    "loadbalancers" : [ ],
    "pool_id" : "d17d07db-5bab-4a15-aa6f-8561af133ca7",
    "ip_version" : "v4",
    "subnet_cidr_id" : "1aee2ab8-f238-4c26-8659-2a7a0c201d0a"
  } ],
  "page_info" : {
    "next_marker" : "fb1ce58f-2525-4bd9-9606-10851533bd22",
    "previous_marker" : "fb19f821-5d5f-4d72-b11c-503e874d3915",
    "current_count" : 2
  }
}

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
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 ListAllMembersSolution {

    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();
        ListAllMembersRequest request = new ListAllMembersRequest();
        try {
            ListAllMembersResponse response = client.listAllMembers(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
# 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 = ListAllMembersRequest()
        response = client.list_all_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
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.ListAllMembersRequest{}
	response, err := client.ListAllMembers(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

操作正常返回。

错误码

请参见错误码

相关文档