文档首页/ 弹性负载均衡 ELB/ API参考/ API（V3）/ 主备后端服务器组/ 查询主备后端服务器组详情
更新时间：2025-08-26 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询主备后端服务器组详情

功能介绍

主备后端服务器组详情。

调用方法

请参见如何调用API。

URI

GET /v3/{project_id}/elb/master-slave-pools/{pool_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：项目ID。获取方式请参见获取项目ID。

约束限制：不涉及

取值范围：长度为32个字符，由小写字母和数字组成。

默认取值：不涉及

pool_id

是

String

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

约束限制：不涉及

取值范围：不涉及

默认取值：不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：IAM鉴权Token。

约束限制：不涉及

取值范围：不涉及

默认取值：不涉及

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

request_id

String

参数解释：请求ID。

取值范围：由数字、小写字母和中划线（-）组成的字符串，自动生成。

pool

MasterSlavePool object

参数解释：后端服务器组对象。
表4 MasterSlavePool

参数

参数类型

描述

description

String

参数解释：后端服务器组的描述信息。

取值范围：不涉及

id

String

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

取值范围：不涉及

lb_algorithm

String

参数解释：后端服务器组的负载均衡算法。

取值范围：不涉及

  • ROUND_ROBIN：加权轮询算法。

  • LEAST_CONNECTIONS：加权最少连接算法。

  • SOURCE_IP：源IP算法。

  • QUIC_CID：连接ID算法。

listeners

Array of ListenerRef objects

参数解释：后端服务器组关联的监听器ID列表。

loadbalancers

Array of LoadBalancerRef objects

参数解释：后端服务器组关联的负载均衡器ID列表。

members

Array of MasterSlaveMember objects

参数解释：后端服务器组中的后端服务器列表。

name

String

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

取值范围：不涉及

project_id

String

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

取值范围：不涉及

protocol

String

参数解释：后端服务器组的后端协议。

取值范围：不涉及TCP、UDP、QUIC、TLS。

session_persistence

SessionPersistence object

参数解释：会话持久性对象。

ip_version

String

参数解释：后端服务器组支持的IP版本。

取值范围：

  • 共享型：固定为v4；

  • 独享型：取值dualstack、v4。当协议为TCP/UDP时，ip_version为dualstack，表示双栈。当协议为HTTP时，ip_version为v4。

created_at

String

参数解释：创建时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。

取值范围：不涉及

注意：独享型实例的历史数据以及共享型实例下的资源，不返回该字段。

updated_at

String

参数解释：更新时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。

取值范围：不涉及

注意：独享型实例的历史数据以及共享型实例下的资源，不返回该字段。

vpc_id

String

参数解释：后端服务器组关联的虚拟私有云的ID。

取值范围：不涉及

type

String

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

取值范围：不涉及

  • instance：允许任意类型的后端，type指定为该类型时，vpc_id是必选字段。

  • ip：只能添加IP类型后端，type指定为该类型时，vpc_id不允许指定。

  • 空字符串（""）：允许任意类型的后端

enterprise_project_id

String

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

取值范围：

  • "0"：表示资源属于default企业项目。

  • UUID格式的字符串，表示非默认企业项目。

healthmonitor

MasterSlaveHealthMonitor object

参数解释：后端服务器组的健康检查。

any_port_enable

Boolean

参数解释：后端是否开启全端口转发。开启后，后端服务器端口与前端监听器端口保持一致。关闭后，请求会转发给后端服务器protocol_port字段指定端口。取值：false 不开启，true 开启。

取值范围：不涉及

connection_drain

ConnectionDrain object

参数解释：后端服务器的延迟注销的功能配置。

以下场景会触发：

  • 后端服务器从后端服务器组中移除。

  • 后端服务器健康检查状态异常。

  • 后端服务器权重修改为0。

取值范围：不涉及

quic_cid_hash_strategy

QuicCidHashStrategy object

参数解释：主备后端服务器组基于部分DST CID的多径分发策略配置。
表5 ListenerRef

参数

参数类型

描述

id

String

参数解释：监听器ID。

取值范围：不涉及
表6 LoadBalancerRef

参数

参数类型

描述

id

String

参数解释：负载均衡器ID。

取值范围：不涉及
表7 MasterSlaveMember

参数

参数类型

描述

id

String

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

取值范围：不涉及

name

String

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

取值范围：不涉及

admin_state_up

Boolean

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

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

取值范围：true、false。

subnet_cidr_id

String

参数解释：后端服务器所在子网的IPv4子网ID或IPv6子网ID。

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

取值范围：不涉及

protocol_port

Integer

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

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

address

String

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

取值范围：不涉及

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

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

取值范围：不涉及

  • ONLINE：后端服务器正常。

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

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

reason

MemberHealthCheckFailedReason object

member_type

String

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

取值范围：

  • ip：跨VPC的member。

  • instance：关联到ECS的member。

instance_id

String

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

取值范围：不涉及

role

String

参数解释：后端服务器的主备状态。

取值范围：不涉及

status

Array of ListenerMemberInfo objects

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

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

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

取值范围：不涉及
表8 MemberHealthCheckFailedReason

参数

参数类型

描述

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"。
表9 ListenerMemberInfo

参数

参数类型

描述

listener_id

String

参数解释：后端服务器关联的监听器ID。

取值范围：不涉及

operating_status

String

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

取值范围：

  • ONLINE：后端服务器正常。

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

  • OFFLINE：后端服务器关联的ECS服务器不存在或已关机或服务异常。
表10 SessionPersistence

参数

参数类型

描述

cookie_name

String

参数解释：cookie名称。

取值范围：最大长度1024个字符。

type

String

参数解释：会话保持类型。

取值范围：SOURCE_IP、HTTP_COOKIE、APP_COOKIE。

persistence_timeout

Integer

参数解释：会话保持的时间。当type为APP_COOKIE时不生效。

取值范围：

  • 若pool的protocol为TCP、UDP和QUIC则范围为[1,60]（分钟），默认值1。

  • 若pool的protocol为HTTP和HTTPS则范围为[1,1440]（分钟），默认值1440。
表11 MasterSlaveHealthMonitor

参数

参数类型

描述

admin_state_up

Boolean

参数解释：健康检查的管理状态。

取值范围：

  • true：表示开启健康检查。

  • false表示关闭健康检查。

delay

Integer

参数解释：健康检查间隔。

取值范围：1-50，单位：秒。

domain_name

String

参数解释：发送健康检查请求的域名。

取值范围：以数字或字母开头，只能包含数字、字母、’-’、’.’。

expected_codes

String

参数解释：期望响应状态码。

取值范围：

  • 单值：单个返回码，例如200。

  • 列表：多个特定返回码，例如200，202。

  • 区间：一个返回码区间，例如200-204。

http_method

String

约束限制：HTTP请求方法。

取值范围：GET、HEAD、POST

id

String

参数解释：健康检查ID

取值范围：不涉及

max_retries

Integer

参数解释：健康检查连续成功多少次后，将后端服务器的健康检查状态由OFFLINE判定为ONLINE。

取值范围：1-10

max_retries_down

Integer

参数解释：健康检查连续失败多少次后，将后端服务器的健康检查状态由ONLINE判定为OFFLINE。

取值范围：1-10

monitor_port

Integer

参数解释：健康检查端口号。

取值范围：1-65535

name

String

参数解释：健康检查名称。

取值范围：不涉及

timeout

Integer

参数解释：一次健康检查请求的超时时间。

取值范围：不涉及

type

String

参数解释：健康检查请求协议。

取值范围：TCP、UDP_CONNECT、HTTP、HTTPS。

url_path

String

参数解释：健康检查请求的请求路径。以"/"开头，默认为"/"。

取值范围：支持使用字母、数字和短划线（-）、正斜线（/）、半角句号（.）、百分号（%）、半角问号（?）、井号（#）和and（&）以及扩展字符集_;~!()*[]@$^:',+
表12 ConnectionDrain

参数

参数类型

描述

enable

Boolean

参数解释：延迟注销功能开关。

约束限制：不涉及

取值范围：true 开启，false 关闭。

默认取值：不涉及

timeout

Integer

参数解释：延迟注销时间。

约束限制：不涉及

取值范围：10~4000，单位：秒。

默认取值：不涉及
表13 QuicCidHashStrategy

参数

参数类型

描述

len

Integer

参数解释：表示hash的时候取CID的长度。

约束限制：仅当负载均衡算法为QUIC_CID的时候才生效。

取值范围：1-20

默认取值：3

offset

Integer

参数解释：表示hash的时候取CID的偏移量。

约束限制：仅当负载均衡算法为QUIC_CID的时候才生效。

取值范围：0-19

默认取值：1

请求示例

GET https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/master-slave-pools/36ce7086-a496-4666-9064-5ba0e6840c75

响应示例

状态码：200

操作正常返回。

{
  "pool" : {
    "lb_algorithm" : "LEAST_CONNECTIONS",
    "type" : "ip",
    "vpc_id" : "3sae7086-a416-4666-9064-5b340e6840125",
    "protocol" : "TCP",
    "description" : "",
    "loadbalancers" : [ {
      "id" : "098b2f68-af1c-41a9-8efd-69958722af62"
    } ],
    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
    "session_persistence" : null,
    "healthmonitor" : {
      "monitor_port" : null,
      "id" : "36ce7086-a496-4666-9064-5ba0e6840c75",
      "domain_name" : "",
      "name" : "My Healthmonitor",
      "max_retries" : 3,
      "max_retries_down" : 3,
      "admin_state_up" : true,
      "type" : "HTTP",
      "timeout" : 30,
      "delay" : 1,
      "http_method" : "get",
      "url_path" : "/",
      "expected_codes" : "200"
    },
    "listeners" : [ {
      "id" : "0b11747a-b139-492f-9692-2df0b1c87193"
    } ],
    "members" : [ {
      "admin_state_up" : true,
      "address" : "172.16.0.210",
      "protocol_port" : 80,
      "id" : "2e7b36d2-66c8-4825-bcd2-211d99978680",
      "operating_status" : "OFFLINE",
      "status" : [ ],
      "instance_id" : "",
      "device_id" : "",
      "device_owner" : "",
      "member_type" : "ip",
      "role" : "master",
      "ip_version" : "v4",
      "name" : "cx-test-master",
      "subnet_cidr_id" : ""
    }, {
      "admin_state_up" : true,
      "address" : "172.16.0.211",
      "protocol_port" : 81,
      "id" : "2e7b36d2-66c8-4823-bsd2-21sa199978681",
      "operating_status" : "OFFLINE",
      "status" : [ ],
      "instance_id" : "",
      "device_id" : "",
      "device_owner" : "",
      "member_type" : "ip",
      "role" : "slave",
      "ip_version" : "v4",
      "name" : "cx-test-slave",
      "subnet_cidr_id" : ""
    } ],
    "id" : "36ce7086-a496-4666-9064-5ba0e6840c75",
    "name" : "My pool",
    "ip_version" : "dualstack",
    "created_at" : "2021-03-26T01:33:12Z",
    "updated_at" : "2021-03-26T01:33:12Z"
  },
  "request_id" : "c1a60da2-1ec7-4a1c-b4cc-73e1a57b368e"
}

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

    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();
        ShowMasterSlavePoolRequest request = new ShowMasterSlavePoolRequest();
        request.withPoolId("{pool_id}");
        try {
            ShowMasterSlavePoolResponse response = client.showMasterSlavePool(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 = ShowMasterSlavePoolRequest()
        request.pool_id = "{pool_id}"
        response = client.show_master_slave_pool(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.ShowMasterSlavePoolRequest{}
	request.PoolId = "{pool_id}"
	response, err := client.ShowMasterSlavePool(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

操作正常返回。

错误码

请参见错误码。

父主题： 主备后端服务器组

相关文档