本文导读

功能介绍
调用方法
URI
请求参数
响应参数
请求示例
响应示例
SDK代码示例
状态码
错误码

展开导读

文档首页/ 弹性负载均衡 ELB/ API参考/ API（V3）/ 后端服务器组/ 查询后端服务器组详情

查询后端服务器组详情

更新时间：2025-05-29 GMT+08:00

在线调试

CLI示例

查看PDF

功能介绍

后端服务器组详情。

调用方法

请参见如何调用API。

URI

GET /v3/{project_id}/elb/pools/{pool_id}

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目ID。
pool_id	是	String	参数解释：后端服务器组ID。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：IAM鉴权Token。

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
request_id	String	请求ID。注：自动生成。
pool	Pool object	后端服务器组对象。

表4 Pool
参数	参数类型	描述
admin_state_up	Boolean	参数解释：后端服务器组的管理状态。
az_affinity	AzAffinity object	参数解释：后端服务器组的可用区亲和策略。
description	String	参数解释：后端服务器组的描述信息。
healthmonitor_id	String	参数解释：后端服务器组关联的健康检查的ID。
id	String	参数解释：后端服务器组的ID。
lb_algorithm	String	参数解释：后端服务器组的负载均衡算法。约束限制：当该字段的取值为SOURCE_IP或QUIC_CID时，后端服务器组绑定的后端服务器的weight字段无效。只有pool的protocol为QUIC时，才支持QUIC_CID算法。取值范围： 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 MemberRef objects	参数解释：后端服务器组中的后端服务器ID列表。
name	String	参数解释：后端服务器组的名称。
project_id	String	参数解释：后端服务器组所在的项目ID。
protocol	String	参数解释：后端服务器组的后端协议。约束限制： listener的protocol为UDP时，pool的protocol必须为UDP或QUIC。 listener的protocol为TCP时pool的protocol必须为TCP。 listener的protocol为HTTP时，pool的protocol必须为HTTP。 listener的protocol为HTTPS时，pool的protocol必须为HTTP、HTTPS或GRPC。 listener的protocol为TERMINATED_HTTPS时，pool的protocol必须为HTTP。 listener的protocol为QUIC时，pool的protocol必须为HTTP、HTTPS或GRPC。 listener的protocol为TLS时，pool的protocol必须为TLS或TCP。若pool的protocol为QUIC，则必须开启session_persistence且type为SOURCE_IP。若pool的protocol为GRPC，关联监听器必须开启HTTP2。若pool的protocol为TCP,则pool的ip_version字段取值必须是4。取值范围：TCP、UDP、TLS、GRPC、HTTP、HTTPS和QUIC。
session_persistence	SessionPersistence object	参数解释：会话持久性对象。
ip_version	String	参数解释：后端服务器组支持的IP版本。取值范围：共享型：固定为v4；独享型：取值dualstack、v4。当协议为TCP/UDP时，ip_version为dualstack，表示双栈。当协议为HTTP时，ip_version为v4。
slow_start	SlowStart object	参数解释：慢启动信息。开启慢启动后，将会在设定的时间段（duration）内对新添加到后端服务器组的后端服务器进行预热，转发到该服务器的请求数量线性增加。约束限制：当后端服务器组的协议为HTTP/HTTPS/GRPC时有效，其他协议传入该字段将报错。
member_deletion_protection_enable	Boolean	参数解释：是否开启误删保护。取值范围：false不开启，true开启。说明：退场时需要先关闭所有资源的删除保护开关。
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：只能添加跨VPC后端，type指定为该类型时，vpc_id不允许指定。] 空字符串（""）：允许任意类型的后端
protection_status	String	参数解释：修改保护状态,。取值范围： nonProtection: 不保护。 consoleProtection: 控制台修改保护。默认取值：nonProtection
protection_reason	String	参数解释：设置保护的原因。作为protection_status的转态设置的原因。约束限制：仅当protection_status为consoleProtection时有效。取值范围：除'<'和'>'外通用Unicode字符集字符，最大255个字符。
any_port_enable	Boolean	参数解释：后端是否开启端口透传。开启后，后端服务器端口与前端监听器端口保持一致。关闭后，请求会转发给后端服务器protocol_port字段指定端口。取值：false不开启，true开启。约束限制：仅QUIC,TCP,UDP的pool支持。
connection_drain	ConnectionDrain object	参数解释：后端服务器的延迟注销的功能配置（只针对TCP、UDP、QUIC协议类型的后端服务器组和TCP、UDP协议类的监听器）以下场景会触发：后端服务器从后端服务器组中移除后端服务器健康检查状态异常后端服务器权重修改为0
enterprise_project_id	String	参数解释：IP地址组所在的企业项目ID。
pool_health	PoolHealth object	参数解释：后端全下线转发配置。
public_border_group	String	参数解释：网络公共边界组，如：center。
quic_cid_hash_strategy	QuicCidHashStrategy object	参数解释：后端服务器组基于部分DST CID的多径分发策略。

表5 AzAffinity
参数	参数类型	描述
enable	Boolean	参数解释：后端服务器组是否开启可用区亲和。开启后，负载均衡器会按照配置的亲和策略进行转发。约束限制：仅IP,TCP,UDP的pool支持。 TLS监听器绑定的pool不支持。开启后，原本的pool_health配置失效。取值范围：false不开启，true开启。
az_minimum_healthy_member_percentage	Integer	参数解释：后端服务器组单可用区百分比健康度最小阈值，当“后端服务器组单可用区百分比健康度”小于该阈值时，触发可用区异常退避策略。“后端服务器组单可用区百分比健康度”是指在一个后端服务器组中，同可用区中健康检查结果正常的服务器数量与该后端服务器组中属于该可用区的后端服务器总数量的比值，百分比结果向上取整。例如：后端服务器组中属于可用区A的后端服务器总数量为3，设置后端服务器组单可用区百分比健康度最小阈值为66时，3x0.66=1.98向上取整为数量阈值2台，即属于可用区A的健康后端数小于2台时触发退避策略；设置后端服务器组单可用区百分比健康度最小阈值为67时，3x0.67=2.01向上取整为数量阈值3台，即属于可用区A的健康后端数小于3台时触发退避策略。约束限制： enable为true时，az_minimum_healthy_member_percentage与az_minimum_healthy_member_count不能同时为-1 enable为true时，az_minimum_healthy_member_percentage与az_minimum_healthy_member_count不能同时不为-1 取值范围：-1至100的整数，0-100为百分比范围，-1表示采用数量阈值。
az_minimum_healthy_member_count	Integer	参数解释：后端服务器组单可用区中数量健康度最小阈值，当“后端服务器组单可用区中数量健康度”小于该阈值时，触发可用区异常退避策略。“后端服务器组单可用区中数量健康度”是指在一个后端服务器组中，属于同一个可用区的健康检查结果正常的服务器数量。约束限制： enable为true时，az_minimum_healthy_member_percentage与az_minimum_healthy_member_count不能同时为-1 enable为true时，az_minimum_healthy_member_percentage与az_minimum_healthy_member_count不能同时不为-1 取值范围：-1至10000的整数，0-10000为数量范围，-1表示采用百分比阈值。
az_unhealthy_fallback_strategy	String	参数解释：后端服务器组单可用区异常退避策略。后端服务器组的健康度小于所配置的最小阈值时，触发该退避策略。 forward_to_all_member_of_local_az：转发至同可用区的所有后端服务器，无论健康检查结果是否正常；forward_to_healthy_member_of_remote_az：转发至非同可用区中所有健康检查结果正常的后端服务器；forward_to_all_healthy_member：转发至所有可用区中健康检查结果正常的后端服务器；forward_to_all_member：转发至所有可用区中的所有后端服务器，无论健康检查结果是否正常取值范围：forward_to_all_member_of_local_az，forward_to_healthy_member_of_remote_az，forward_to_all_healthy_member，forward_to_all_member。默认值：forward_to_all_member_of_local_az

表6 ListenerRef
参数	参数类型	描述
id	String	参数解释：监听器ID。

表7 LoadBalancerRef
参数	参数类型	描述
id	String	参数解释：负载均衡器ID。

表8 MemberRef
参数	参数类型	描述
id	String	参数解释：后端服务器ID。

表9 SessionPersistence
参数	参数类型	描述
cookie_name	String	参数解释：cookie名称。约束限制：只有当type为APP_COOKIE时才有效。其他情况下传该字段会报错。取值范围：共享型LB，支持字母、数字、中划线(-)和下划线(_)，最大长度64个字符。独享型LB，支持字母、数字、中划线(-)、下划线(_)和点号(.)，最大长度255个字符。
type	String	参数解释：会话保持类型。约束限制：当pool的protocol为TCP、UDP，无论type取值如何，都会被忽略，会话保持只按SOURCE_IP生效。当pool的protocol为HTTP、HTTPS时。如果是独享型负载均衡器的pool，则type只能为HTTP_COOKIE，其他取值会话保持失效。如果是共享型负载均衡器的pool，则type可以为HTTP_COOKIE和APP_COOKIE，其他取值会话保持失效。若pool的protocol为QUIC，则必须开启session_persistence且type为SOURCE_IP。取值范围：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。

**表10** SlowStart
参数	参数类型	描述
enable	Boolean	参数解释：慢启动的开关。取值范围： true：开启。 false：关闭。默认取值：false
duration	Integer	参数解释：慢启动的持续时间。取值范围：30-1200，单位：秒。默认取值：30

**表11** ConnectionDrain
参数	参数类型	描述
enable	Boolean	参数解释：延迟注销功能开关。取值范围：true 开启，false 关闭。默认取值：true。
timeout	Integer	参数解释：延迟注销时间。取值范围：10~4000，单位：秒。

**表12** PoolHealth
参数	参数类型	描述
minimum_healthy_member_count	Integer	参数解释：当健康检查在线的member个数小于该个数，判定pool的state为不健康。取值范围： 0：默认值，不生效。 1：全下线转发生效。

**表13** QuicCidHashStrategy
参数	参数类型	描述
len	Integer	参数解释：仅当负载均衡算法为QUIC_CID的时候才生效，表示hash的时候取CID的长度。取值范围：1-20 默认取值：3
offset	Integer	参数解释：仅当负载均衡算法为QUIC_CID的时候才生效，表示hash的时候取CID的偏移量。取值范围：0-19 默认取值：1

请求示例

查询后端服务器组详情

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

响应示例

状态码：200

操作正常返回。

{
  "pool" : {
    "type" : "",
    "vpc_id" : "",
    "lb_algorithm" : "LEAST_CONNECTIONS",
    "protocol" : "TCP",
    "description" : "My pool",
    "admin_state_up" : true,
    "member_deletion_protection_enable" : false,
    "loadbalancers" : [ {
      "id" : "098b2f68-af1c-41a9-8efd-69958722af62"
    } ],
    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
    "session_persistence" : null,
    "healthmonitor_id" : "",
    "listeners" : [ {
      "id" : "0b11747a-b139-492f-9692-2df0b1c87193"
    }, {
      "id" : "61942790-2367-482a-8b0e-93840ea2a1c6"
    }, {
      "id" : "fd8f954c-f0f8-4d39-bb1d-41637cd6b1be"
    } ],
    "members" : [ ],
    "id" : "36ce7086-a496-4666-9064-5ba0e6840c75",
    "name" : "My pool.",
    "ip_version" : "dualstack",
    "pool_health" : {
      "minimum_healthy_member_count" : 0
    },
    "az_affinity" : {
      "enable" : "true,",
      "az_minimum_healthy_member_percentage" : -1,
      "az_minimum_healthy_member_count" : 10000,
      "az_unhealthy_fallback_strategy" : "forward_to_all_member_of_local_az"
    }
  },
  "request_id" : "c1a60da2-1ec7-4a1c-b4cc-73e1a57b368e"
}

SDK代码示例

SDK代码示例如下。

Java
Python
Go
更多

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

    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();
        ShowPoolRequest request = new ShowPoolRequest();
        request.withPoolId("{pool_id}");
        try {
            ShowPoolResponse response = client.showPool(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());
        }
    }
}

        

      
     

      
       
         
         # 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 = ShowPoolRequest()
        request.pool_id = "{pool_id}"
        response = client.show_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)

        

      
     

      
       
         
         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.ShowPoolRequest{}
	request.PoolId = "{pool_id}"
	response, err := client.ShowPool(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

        

      
     

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

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

    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();
        ShowPoolRequest request = new ShowPoolRequest();
        request.withPoolId("{pool_id}");
        try {
            ShowPoolResponse response = client.showPool(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());
        }
    }
}

        

      
     

      
       
         
         # 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 = ShowPoolRequest()
        request.pool_id = "{pool_id}"
        response = client.show_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)

        

      
     

      
       
         
         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.ShowPoolRequest{}
	request.PoolId = "{pool_id}"
	response, err := client.ShowPool(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

        

      
     

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

状态码


状态码	描述
200	操作正常返回。

错误码

请参见错误码。

父主题：后端服务器组

上一篇：查询后端服务器组列表

下一篇：更新后端服务器组

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

查询后端服务器组详情

功能介绍

调用方法

URI

请求参数

响应参数

请求示例

响应示例

SDK代码示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

文档反馈