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

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

在线调试

CLI示例

查看PDF

查询后端服务器组列表

功能介绍

后端服务器组列表。

接口约束

分页查询使用的参数为marker、limit、page_reverse。
marker和page_reverse只有和limit一起使用时才会生效，单独使用无效。

调用方法

请参见如何调用API。

URI

GET /v3/{project_id}/elb/pools

表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。
description	否	Array of strings	后端服务器组的描述信息。支持多值查询，查询条件格式：description=xxx&description=xxx。
admin_state_up	否	Boolean	后端服务器组的管理状态。
healthmonitor_id	否	Array of strings	后端服务器组关联的健康检查的ID。支持多值查询，查询条件格式：healthmonitor_id=xxx&healthmonitor_id=xxx。
id	否	Array of strings	后端服务器组的ID。支持多值查询，查询条件格式：id=xxx&id=xxx。
name	否	Array of strings	后端服务器组的名称。支持多值查询，查询条件格式：name=xxx&name=xxx。
loadbalancer_id	否	Array of strings	后端服务器组绑定的负载均衡器ID。支持多值查询，查询条件格式：loadbalancer_id=xxx&loadbalancer_id=xxx。
protocol	否	Array of strings	后端服务器组的后端协议。取值：TCP、UDP、TLS、HTTP、HTTPS、QUIC和GRPC。支持多值查询，查询条件格式：protocol=xxx&protocol=xxx。
lb_algorithm	否	Array of strings	后端服务器组的负载均衡算法。取值： ROUND_ROBIN：加权轮询算法。 LEAST_CONNECTIONS：加权最少连接算法。 SOURCE_IP：源IP算法。 QUIC_CID：连接ID算法。支持多值查询，查询条件格式：lb_algorithm=xxx&lb_algorithm=xxx。
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版本。支持多值查询，查询条件格式：ip_version=xxx&ip_version=xxx。
member_address	否	Array of strings	后端服务器的IP地址。仅用于查询条件，不作为响应参数字段。支持多值查询，查询条件格式：member_address=xxx&member_address=xxx。
member_device_id	否	Array of strings	后端服务器对应的弹性云服务器的ID。仅用于查询条件，不作为响应参数字段。支持多值查询，查询条件格式：member_device_id=xxx&member_device_id=xxx。
member_deletion_protection_enable	否	Boolean	是否开启删除保护，false不开启，true开启，不传查询全部。
listener_id	否	Array of strings	关联的监听器ID，包括通过l7policy关联的。支持多值查询，查询条件格式：listener_id=xxx&listener_id=xxx。
member_instance_id	否	Array of strings	后端服务器ID。仅用于查询条件，不作为响应参数字段。支持多值查询，查询条件格式：member_instance_id=xxx&member_instance_id=xxx。
vpc_id	否	Array of strings	后端服务器组关联的虚拟私有云的ID。
type	否	Array of strings	后端服务器组的类型。取值： instance：允许任意类型的后端，type指定为该类型时，vpc_id是必选字段。 ip：只能添加跨VPC后端，type指定为该类型时，vpc_id不允许指定。空字符串（""）：允许任意类型的后端

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	IAM鉴权Token

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
request_id	String	请求ID。注：自动生成。
page_info	PageInfo object	分页信息。
pools	Array of Pool objects	后端服务器组列表。

表5 PageInfo
参数	参数类型	描述
previous_marker	String	参数解释：分页查询结果中第一条记录的ID。通常用于配合page_reverse=true查询上一页。
next_marker	String	参数解释：分页查询结果中最后一条记录的ID。通常用于查询下一页。
current_count	Integer	参数解释：当前的记录数。

表6 Pool
参数	参数类型	描述
admin_state_up	Boolean	参数解释：后端服务器组的管理状态。
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时有效，其他协议传入该字段将报错。
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不允许指定。] 空字符串（""）：允许任意类型的后端
enterprise_project_id	String	参数解释：IP地址组所在的企业项目ID。

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

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

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

**表10** 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。

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

请求示例

后端服务器组列表

GET https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/pools?limit=2

响应示例

状态码： 200

操作正常返回。

{
  "pools" : [ {
    "lb_algorithm" : "ROUND_ROBIN",
    "protocol" : "HTTP",
    "type" : "",
    "vpc_id" : "",
    "description" : "",
    "admin_state_up" : true,
    "member_deletion_protection_enable" : false,
    "loadbalancers" : [ {
      "id" : "309a0f61-0b62-45f2-97d1-742f3434338e"
    } ],
    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
    "session_persistence" : {
      "cookie_name" : "my_cookie",
      "type" : "APP_COOKIE",
      "persistence_timeout" : 1
    },
    "healthmonitor_id" : "",
    "listeners" : [ ],
    "members" : [ ],
    "id" : "73bd4fe0-ffbb-4b56-aab4-4f26ddf7a103",
    "name" : "",
    "ip_version" : "v4",
    "pool_health" : {
      "minimum_healthy_member_count" : 0
    }
  }, {
    "lb_algorithm" : "SOURCE_IP",
    "protocol" : "TCP",
    "description" : "",
    "admin_state_up" : true,
    "member_deletion_protection_enable" : false,
    "loadbalancers" : [ {
      "id" : "d9763e59-64b7-4e93-aec7-0ff7881ef9bc"
    } ],
    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
    "session_persistence" : {
      "cookie_name" : "",
      "type" : "SOURCE_IP",
      "persistence_timeout" : 1
    },
    "healthmonitor_id" : "",
    "listeners" : [ {
      "id" : "8d21db6f-b475-429e-a9cb-90439b0413b2"
    } ],
    "members" : [ ],
    "id" : "74db02d1-5711-4c77-b383-a450e2b93142",
    "name" : "pool_tcp_001",
    "ip_version" : "dualstack",
    "pool_health" : {
      "minimum_healthy_member_count" : 0
    }
  } ],
  "page_info" : {
    "next_marker" : "74db02d1-5711-4c77-b383-a450e2b93142",
    "previous_marker" : "73bd4fe0-ffbb-4b56-aab4-4f26ddf7a103",
    "current_count" : 2
  },
  "request_id" : "a1a7e852-1928-48f7-bbc9-ca8469898713"
}

SDK代码示例

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

    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();
        ListPoolsRequest request = new ListPoolsRequest();
        try {
            ListPoolsResponse response = client.listPools(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 = ListPoolsRequest()
        response = client.list_pools(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.ListPoolsRequest{}
	response, err := client.ListPools(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     

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

状态码

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

错误码

请参见错误码。

父主题：后端服务器组

上一篇：创建后端服务器组

下一篇：查询后端服务器组详情

意见反馈

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

有帮助没帮助

提供反馈

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

系统繁忙，请稍后重试

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

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

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

字符长度不能超过500

直接提交取消

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

智能客服提问云社区提问

查询后端服务器组列表

功能介绍

接口约束

调用方法

URI

请求参数

响应参数

请求示例

响应示例

SDK代码示例

状态码

错误码

相关文档

意见反馈

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

7*24

备案

专业服务

退订

建议反馈

售前咨询热线