更新时间:2022-03-31 GMT+08:00
分享

查询后端服务器组列表

功能介绍

后端服务器组列表。

接口约束

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

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

调试

您可以在API Explorer中调试该接口。

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表示从前往后分页,默认为false。使用说明:必须与limit一起使用。

description

Array

后端云服务器组的描述信息。

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

admin_state_up

Boolean

后端云服务器组的管理状态。

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

healthmonitor_id

Array

后端云服务器组关联的健康检查的ID。

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

id

Array

后端云服务器组的ID。

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

name

Array

后端云服务器组的名称。

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

loadbalancer_id

Array

后端云服务器组绑定的负载均衡器ID。

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

protocol

Array

后端云服务器组的后端协议。取值:TCP、UDP、HTTP、HTTPS和QUIC。

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

lb_algorithm

Array

后端云服务器组的负载均衡算法。

取值: 1、ROUND_ROBIN:加权轮询算法。 2、LEAST_CONNECTIONS:加权最少连接算法。 3、SOURCE_IP:源IP算法。 4、QUIC_CID:连接ID算法。

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

enterprise_project_id

Array

企业项目ID。

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

ip_version

Array

后端云服务器组支持的IP版本。取值:

  • 共享型LB下的pool:固定为v4;

  • 独享型LB下的pool:dualstack、v4。当该pool的协议为TCP/UDP/QUIC时,ip_version为dualstack,表示双栈。当协议为HTTP/HTTPS时,ip_version为v4。

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

member_address

Array

后端云服务器的IP地址。仅用于查询条件,不作为响应参数字段。

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

member_device_id

Array

后端云服务器对应的弹性云服务器的ID。仅用于查询条件,不作为响应参数字段。

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

member_deletion_protection_enable

Boolean

是否开启删除保护,false不开启,true开启,不传查询全部。

listener_id

Array

关联的监听器ID,包括通过l7policy关联的。

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

member_instance_id

Array

后端云服务器ID。仅用于查询条件,不作为响应参数字段。

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

请求参数

表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

next_marker

String

分页查询结果中最后一条记录的ID。

current_count

Integer

当前的记录数。

表6 Pool

参数

参数类型

描述

admin_state_up

Boolean

后端云服务器组的管理状态,只支持设置为true。

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

description

String

后端云服务器组的描述信息。

healthmonitor_id

String

后端云服务器组关联的健康检查的ID。

id

String

后端云服务器组的ID。

lb_algorithm

String

后端云服务器组的负载均衡算法。

取值: 1、ROUND_ROBIN:加权轮询算法。 2、LEAST_CONNECTIONS:加权最少连接算法。 3、SOURCE_IP:源IP算法。 4、QUIC_CID:连接ID算法。

使用说明:

  • 当该字段的取值为SOURCE_IP时,后端云服务器组绑定的后端云服务器的weight字段无效。

  • 只有pool的protocol为QUIC时,才支持QUIC_CID算法。

listeners

Array of ListenerRef objects

后端云服务器组关联的监听器ID列表。实际上只会有一个关联的监听器ID。

loadbalancers

Array of LoadBalancerRef objects

后端云服务器组关联的负载均衡器ID列表。实际只会有一个关联的负载均衡器ID。

members

Array of MemberRef objects

后端云服务器组中的后端云服务器ID列表。

name

String

后端云服务器组的名称。

project_id

String

后端云服务器组所在的项目ID。

protocol

String

后端云服务器组的后端协议。

取值:TCP、UDP、HTTP、HTTPS和QUIC。

使用说明:

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

  • listener的protocol为TERMINATED_HTTPS时,pool的protocol必须为HTTP。

session_persistence

SessionPersistence object

会话持久性对象。

ip_version

String

后端云服务器组支持的IP版本。[取值:

共享型:默认为v4;

独享型:取值范围(dualstack、v4、v6)。当协议为TCP/UDP时,ip_version为dualstack,表示双栈。当协议为HTTP时,ip_version为v4。

slow_start

SlowStart object

慢启动信息。开启慢启动后,将会在设定的时间段(duration)内对新添加到后端服务器组的后端服务器进行预热,转发到该服务器的请求数量线性增加。

当后端服务器组的协议为HTTP/HTTPS时有效,其他协议传入该字段将报错。

member_deletion_protection_enable

Boolean

是否开启误删保护。取值:false不开启,true开启。

说明:

退场时需要先关闭所有资源的删除保护开关。

表7 ListenerRef

参数

参数类型

描述

id

String

监听器ID。

表8 LoadBalancerRef

参数

参数类型

描述

id

String

负载均衡器ID。

表9 MemberRef

参数

参数类型

描述

id

String

后端服务器ID。

表10 SessionPersistence

参数

参数类型

描述

cookie_name

String

cookie名称。

格式:仅支持字母、数字、中划线(-)、下划线(_)和点号(.)。

使用说明:

  • 只有当type为APP_COOKIE时才有效。

type

String

会话保持类型。 取值范围:SOURCE_IP、HTTP_COOKIE、APP_COOKIE。

使用说明:

  • 当pool的protocol为TCP、UDP,无论type取值如何,都会被忽略,会话保持只按SOURCE_IP生效;

  • 当pool的protocol为HTTP、HTTPS时,如果是独享型负载均衡器的pool,则type只能为HTTP_COOKIE,其他取值会话保持失效。如果是共享型负载均衡器的pool,则type可以为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

慢启动的开关,默认值:false; true:开启; false:关闭

缺省值:false

duration

Integer

慢启动的持续时间。取值:30~1200s,默认30s;

最小值:30

最大值:1200

缺省值:30

请求示例

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

响应示例

状态码: 200

操作正常返回。

{
  "pools" : [ {
    "lb_algorithm" : "ROUND_ROBIN",
    "protocol" : "HTTP",
    "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"
  }, {
    "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"
  } ],
  "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

操作正常返回。

错误码

请参见错误码

分享:

    相关文档

    相关产品

close