调用ListListeners查询监听列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListListeners

系统规定的参数。取值:ListListeners

NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次API调用返回的NextToken值。
MaxResults Integer 50

本次读取的最大数据记录数量,此参数为可选参数。取值范围:1~100。入参为空时,默认值为20

ListenerIds Array of String lsr-bp1bpn0kn908w4nbw****

监听实例ID。最多支持20个监听ID。

LoadBalancerIds Array of String lb-bp1b6c719dfa08ex*****

负载均衡实例ID。最多支持20个负载均衡实例ID。

ListenerProtocol String HTTP

需要过滤的监听协议。取值:

  • HTTP:协议类型为HTTP。
  • HTTPS:协议类型为HTTPS。
  • QUIC:协议类型为QUIC。

返回数据

名称 类型 示例值 描述
Listeners Array of listener

负载均衡监听列表。

DefaultActions Array of defaultAction

默认规则动作列表。

ForwardGroupConfig Object

转发规则动作对应的配置。动作类型为FowardGroup时必填且有效。

ServerGroupTuples Array of serverGroupTuple

转发目标服务器组。

ServerGroupId String rsp-cige6j****

转发到的目的服务器组ID。

Type String ForwardGroup

动作类型。取值:ForwardGroup,表示转发至多个虚拟服务器组。

GzipEnabled Boolean false

是否开启Gzip压缩,对特定文件类型进行压缩。取值:

  • true:是。
  • false:否。
Http2Enabled Boolean false

是否开启HTTP/2特性。取值:

  • true:是。
  • false:否。
说明 仅HTTPS监听支持此参数。
IdleTimeout Integer 3

指定连接空闲超时时间。单位:秒。取值范围:1~60

如果在超时时间内一直没有访问请求,负载均衡会暂时中断当前连接,直到接收到下一次请求时重新建立新的连接。

ListenerDescription String test

设置监听的描述信息。长度为2~256个字符。

ListenerId String lsr-bp1bpn0kn908w4nbw****

监听ID。

ListenerPort Integer 80

负载均衡实例前端使用的端口。取值:1~65535

ListenerProtocol String HTTP

监听协议。取值:

  • HTTP:协议类型为HTTP。
  • HTTPS:协议类型为HTTPS。
  • QUIC:协议类型为QUIC。
ListenerStatus String Running

当前监听的状态,取值:

  • Provisioning:创建中。
  • Running:运行中。
  • Configuring:配置中。
  • Stopped:已停止。
LoadBalancerId String lb-bp1b6c719dfa08ex*****

负载均衡实例ID。

LogConfig Object

日志配置。

AccessLogRecordCustomizedHeadersEnabled Boolean true

访问日志是否开启携带自定义头。取值:

  • true:是。
  • false:否。
AccessLogTracingConfig Object

访问日志Xtrace相关的配置信息。

TracingEnabled Boolean true

是否开启Xtrace功能。取值:

  • true:是。
  • false:否。
说明 只有实例访问日志开关AccessLogEnabled打开时,才能设置此参数为true
TracingSample Integer 100

Xtrace的采样率。取值:1~10000

说明 TracingEnabledtrue时,此值有效。
TracingType String Zipkin

Xtrace类型,合法取值为Zipkin

说明 TracingEnabledtrue时,此值有效。
QuicConfig Object

启用关联QUIC监听时的配置信息。

QuicListenerId String lsr-bp1bpn908w4nbw****

需要关联的QUIC监听ID。QuicUpgradeEnabledtrue时必选。HTTPS监听时有效。

说明 原始监听和关联的QUIC监听必须属于同一个ALB实例,并且此QUIC监听之前没有被关联过。
QuicUpgradeEnabled Boolean true

是否开启QUIC升级。取值:

  • true:是。
  • false:否。
说明 仅HTTPS监听时有效。
RequestTimeout Integer 34

指定请求超时时间。单位:秒。取值:1~180

如果在超时时间内后端服务器一直没有响应,负载均衡将放弃等待,给客户端返回HTTP 504错误码。

SecurityPolicyId String tls_cipher_policy_1_1

安全策略。

说明 仅HTTPS监听支持此参数。
XForwardedForConfig Object

XForward头字段配置信息。