更新时间:2025-02-24 GMT+08:00

查询后端服务器组列表

功能介绍

后端服务器组列表。

接口约束

  • 分页查询使用的参数为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。

如果enterprise_project_id不传值,默认查询所有企业项目下的资源,鉴权按照细粒度权限鉴权,必须在用户组下分配elb:pools:list权限。

如果enterprise_project_id传值,鉴权按照企业项目权限鉴权,分为传入具体eps_id和all_granted_eps两种场景,前者查询指定eps_id的eps下的资源,后者查询的是所有有list权限的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不允许指定。

  • 空字符串(""):允许任意类型的后端

quic_cid_len

Integer

查询相同QUIC CID策略配置的后端服务器组,仅用于查询条件,不作为响应参数字段。

支持多值查询,查询条件格式:quic_cid_len=3&quic_cid_len=5

quic_cid_offset

Integer

查询相同QUIC CID策略配置的后端服务器组,仅用于查询条件,不作为响应参数字段。

支持多值查询,查询条件格式:quic_cid_offset=1&quic_cid_offset=3

请求参数

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

quic_cid_hash_strategy

QuicCidHashStrategy object

参数解释:后端服务器组基于部分DST CID的多径分发策略。

表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

表12 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?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"
}

状态码

状态码

描述

200

操作正常返回。

错误码

请参见错误码