查询后端服务器组列表

project_id

是

String

项目ID。

marker

否

String

上一页最后一条记录的ID。

使用说明：

• 必须与limit一起使用。

• 不指定时表示查询第一页。

• 该字段不允许为空或无效的ID。

limit

否

Integer

每页返回的个数。

最小值：0

最大值：2000

缺省值：2000

page_reverse

否

Boolean

是否反向查询。

取值：

• true：查询上一页。

• false：查询下一页，默认。

使用说明：

• 必须与limit一起使用。

• 当page_reverse=true时，若要查询上一页，marker取值为当前页返回值的previous_marker。

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和TCPSSL。

支持多值查询，查询条件格式：protocol=xxx&protocol=xxx。

lb_algorithm

否

Array

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

取值：

• ROUND_ROBIN：加权轮询算法。

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

• SOURCE_IP：源IP算法。

• QUIC_CID：连接ID算法。

支持多值查询，查询条件格式：lb_algorithm=xxx&lb_algorithm=xxx。

enterprise_project_id

否

Array

企业项目ID。不传时查询default企业项目"0"下的资源，鉴权按照default企业项目鉴权； 如果传值，则传已存在的企业项目ID或all_granted_eps（表示查询所有企业项目）进行查询。

支持多值查询，查询条件格式：enterprise_project_id=xxx&enterprise_project_id=xxx。

ip_version

否

Array

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

支持多值查询，查询条件格式：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。

vpc_id

否

Array

后端云服务器组关联的虚拟私有云的ID。

type

否

Array

后端服务器组的类型。

取值：

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

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

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

X-Auth-Token

是

String

IAM鉴权Token

request_id

String

请求ID。

注：自动生成 。

page_info

PageInfo object

分页信息。

pools

Array of Pool objects

后端服务器组列表。

previous_marker

String

分页查询结果中第一条记录的ID。通常用于配合page_reverse=true查询上一页。

next_marker

String

分页查询结果中最后一条记录的ID。通常用于查询下一页。

current_count

Integer

当前的记录数。

admin_state_up

Boolean

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

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

description

String

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

healthmonitor_id

String

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

id

String

后端云服务器组的ID。

lb_algorithm

String

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

取值：

• ROUND_ROBIN：加权轮询算法。

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

• SOURCE_IP：源IP算法。

• QUIC_CID：连接ID算法。

使用说明：

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

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

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

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

取值：TCP、UDP、HTTP、HTTPS、QUIC和TCPSSL。

使用说明：

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

• 若pool的protocol为QUIC，则必须开启session_persistence且type为SOURCE_IP。

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开启。

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不允许指定。

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

id

String

监听器ID。

id

String

负载均衡器ID。

id

String

后端服务器ID。

cookie_name

String

cookie名称。

共享型LB，支持字母、数字、中划线(-)和下划线()，最大长度64个字符。 独享型LB，支持字母、数字、中划线(-)、下划线()和点号(.)，最大长度255个字符。

使用说明：

• 只有当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，其他取值会话保持失效。

• 若pool的protocol为QUIC，则必须开启session_persistence且type为SOURCE_IP。

persistence_timeout

Integer

会话保持的时间。当type为APP_COOKIE时不生效。

适用范围：如果pool的protocol为TCP、UDP和QUIC则范围为[1,60]（分钟），默认值1； 如果pool的protocol为HTTP和HTTPS则范围为[1,1440]（分钟），默认值1440。

enable

Boolean

慢启动的开关，默认值：false； true：开启； false：关闭

缺省值：false

duration

Integer

慢启动的持续时间。取值：30~1200s，默认30s；

最小值：30

最大值：1200

缺省值：30

200

操作正常返回。