调用ListListeners查询监听列表。

调试

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

请求参数

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

要执行的操作。

取值:ListListeners

NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

用来标记当前开始读取的位置,设置为空表示从头开始。

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

需要过滤的监听协议。

取值:HTTPHTTPSQUIC

返回数据

名称 类型 示例值 描述
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压缩,对特定文件类型进行压缩。

取值:truefalse

默认值:true

Http2Enabled Boolean false

是否开启HTTP/2特性。

取值:truefalse

默认值:true

说明 仅HTTPS监听支持此参数。
IdleTimeout Integer 3

指定连接空闲超时时间。

取值范围:1~60秒。

默认值:15秒。

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

ListenerDescription String test

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

ListenerId String lsr-bp1bpn0kn908w4nbw****

监听ID。

ListenerPort Integer 80

负载均衡实例前端使用的端口。

取值:1~65535

ListenerProtocol String HTTP

监听协议。

取值:HTTPHTTPSQUIC

ListenerStatus String active

当前监听的状态:

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

负载均衡实例ID。

LogConfig Object

日志配置。

AccessLogRecordCustomizedHeadersEnabled Boolean true

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

取值:truefalse

默认值:false

AccessLogTracingConfig Object

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

TracingEnabled Boolean true

Xtrace功能状态。

取值:truefalse

默认值:false

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

Xtrace的采样率。

取值:1~10000

说明 TracingEnabled为true时,此值有效。
TracingType String Zipkin

Xtrace类型,合法取值为Zipkin

说明 TracingEnabled为true时,此值有效。
QuicConfig Object

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

QuicListenerId String lsr-bp1bpn908w4nbw****

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

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

是否开启QUIC升级。

取值:truefalse

默认值:false

说明 仅HTTPS监听时有效。
RequestTimeout Integer 34

指定请求超时时间。

取值:1~180秒。

默认值:60秒。

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

SecurityPolicyId String tls_cipher_policy_1_1

安全策略。

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

XForward字段配置信息。

XForwardedForClientCertClientVerifyAlias String test_client-verify-alias_123456

自定义头名称,只有当XForwardedForClientCertClientVerifyEnabled的值为true的时候,此值才会生效;否则该值不会生效。

取值限制:长度为1~40字符。支持字母a-z、数字、短划线(-)和下划线(_)。

说明 仅HTTPS监听支持此参数。
XForwardedForClientCertClientVerifyEnabled Boolean true

是否通过X-Forwarded-Clientcert-clientverify头字段获取对访问负载均衡实例客户端证书的校验结果。

取值:truefalse

默认值:false

说明 仅HTTPS监听支持此参数。
XForwardedForClientCertFingerprintAlias String test_finger-print-alias_123456

自定义头名称,只有当XForwardedForClientCertFingerprintEnabled的值为true时生效。

取值限制:长度为1~40字符。支持字母a-z、数字、短划线(-)和下划线(_)。

说明 仅HTTPS监听支持此参数。
XForwardedForClientCertFingerprintEnabled Boolean true

是否通过X-Forwarded-Clientcert-fingerprint头字段获取访问负载均衡实例客户端证书的指纹取值。

取值:truefalse

默认值:false

说明 仅HTTPS监听支持此参数。
XForwardedForClientCertIssuerDNAlias String test_issue-dn-alias_123456

自定义头名称,只有当XForwardedForClientCertIssuerDNEnabled的值为On的时候,此值才会生效。

取值限制:长度为1~40字符。支持字母a-z、数字、短划线(-)和下划线(_)。

说明 仅HTTPS监听支持此参数。
XForwardedForClientCertIssuerDNEnabled Boolean true

是否通过X-Forwarded-Clientcert-issuerdn头字段获取访问负载均衡实例客户端证书的发行者信息。

取值:truefalse

默认值:false

说明 仅HTTPS监听支持此参数。
XForwardedForClientCertSubjectDNAlias String test_subject-dn-alias_123456

自定义头名称,只有当XForwardedForClientCertSubjectDNEnabled的值为true时,此值才会生效。

取值限制:长度为1~40字符。支持字母a-z、数字、短划线(-)和下划线(_)。

说明 仅HTTPS监听支持此参数。
XForwardedForClientCertSubjectDNEnabled Boolean true

是否通过X-Forwarded-Clientcert-subjectdn头字段获取访问负载均衡实例客户端证书的所有者信息。

取值:truefalse

默认值:false

说明 仅HTTPS监听支持此参数。
XForwardedForClientSrcPortEnabled Boolean true

是否通过X-Forwarded-Client-Port头字段获取访问负载均衡实例客户端的端口。

取值:truefalse

默认值:false

说明 HTTP和HTTPS监听支持此参数。
XForwardedForEnabled Boolean true

是否开启通过X-Forwarded-For头字段获取来访者真实 IP。

取值:truefalse

默认值:true

说明 HTTP和HTTPS监听支持此参数。
XForwardedForProtoEnabled Boolean true

是否通过X-Forwarded-Proto头字段获取负载均衡实例的监听协议。

取值:truefalse

默认值:false

说明 HTTP、HTTPS和QUIC监听支持此参数。
XForwardedForSLBIdEnabled Boolean true

是否通过SLB-ID头字段获取负载均衡实例ID。

取值:truefalse

默认值:false

说明 HTTP、HTTPS和QUIC监听支持此参数。
XForwardedForSLBPortEnabled Boolean true

是否通过X-Forwarded-Port头字段获取负载均衡实例的监听端口。

取值:truefalse

默认值:false

说明 HTTP、HTTPS和QUIC监听支持此参数。
MaxResults Integer 50

本次请求所返回的最大记录条数。

NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

当前调用返回读取到的位置,设置为空代表数据已经读取完毕。

RequestId String 365F4154-92F6-4AE4-92F8-7FF34B540710

请求ID。

TotalCount Integer 1000

本次请求条件下的数据总量。

示例

请求示例

http(s)://[Endpoint]/?Action=ListListeners
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&MaxResults=50
&ListenerIds=["lsr-bp1bpn0kn908w4nbw****"]
&LoadBalancerIds=["lb-bp1b6c719dfa08ex*****"]
&ListenerProtocol=HTTP
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListListenersResponse>
    <Listeners>
        <DefaultActions>
            <ForwardGroupConfig>
                <ServerGroupTuples>
                    <ServerGroupId>rsp-cige6j****</ServerGroupId>
                </ServerGroupTuples>
            </ForwardGroupConfig>
            <Type>ForwardGroup</Type>
        </DefaultActions>
        <GzipEnabled>false</GzipEnabled>
        <Http2Enabled>false</Http2Enabled>
        <IdleTimeout>3</IdleTimeout>
        <ListenerDescription>test</ListenerDescription>
        <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>
        <ListenerPort>80</ListenerPort>
        <ListenerProtocol>HTTP</ListenerProtocol>
        <ListenerStatus>active</ListenerStatus>
        <LoadBalancerId>lb-bp1b6c719dfa08ex*****</LoadBalancerId>
        <LogConfig>
            <AccessLogRecordCustomizedHeadersEnabled>true</AccessLogRecordCustomizedHeadersEnabled>
            <AccessLogTracingConfig>
                <TracingEnabled>true</TracingEnabled>
                <TracingSample>100</TracingSample>
                <TracingType>Zipkin</TracingType>
            </AccessLogTracingConfig>
        </LogConfig>
        <QuicConfig>
            <QuicListenerId>lsr-bp1bpn908w4nbw****</QuicListenerId>
            <QuicUpgradeEnabled>true</QuicUpgradeEnabled>
        </QuicConfig>
        <RequestTimeout>34</RequestTimeout>
        <SecurityPolicyId>tls_cipher_policy_1_1</SecurityPolicyId>
        <XForwardedForConfig>
            <XForwardedForClientCertClientVerifyAlias>test_client-verify-alias_123456</XForwardedForClientCertClientVerifyAlias>
            <XForwardedForClientCertClientVerifyEnabled>true</XForwardedForClientCertClientVerifyEnabled>
            <XForwardedForClientCertFingerprintAlias>test_finger-print-alias_123456</XForwardedForClientCertFingerprintAlias>
            <XForwardedForClientCertFingerprintEnabled>true</XForwardedForClientCertFingerprintEnabled>
            <XForwardedForClientCertIssuerDNAlias>test_issue-dn-alias_123456</XForwardedForClientCertIssuerDNAlias>
            <XForwardedForClientCertIssuerDNEnabled>true</XForwardedForClientCertIssuerDNEnabled>
            <XForwardedForClientCertSubjectDNAlias>test_subject-dn-alias_123456</XForwardedForClientCertSubjectDNAlias>
            <XForwardedForClientCertSubjectDNEnabled>true</XForwardedForClientCertSubjectDNEnabled>
            <XForwardedForClientSrcPortEnabled>true</XForwardedForClientSrcPortEnabled>
            <XForwardedForEnabled>true</XForwardedForEnabled>
            <XForwardedForProtoEnabled>true</XForwardedForProtoEnabled>
            <XForwardedForSLBIdEnabled>true</XForwardedForSLBIdEnabled>
            <XForwardedForSLBPortEnabled>true</XForwardedForSLBPortEnabled>
        </XForwardedForConfig>
    </Listeners>
    <MaxResults>50</MaxResults>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
    <TotalCount>1000</TotalCount>
</ListListenersResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Listeners" : {
    "DefaultActions" : {
      "ForwardGroupConfig" : {
        "ServerGroupTuples" : {
          "ServerGroupId" : "rsp-cige6j****"
        }
      },
      "Type" : "ForwardGroup"
    },
    "GzipEnabled" : false,
    "Http2Enabled" : false,
    "IdleTimeout" : 3,
    "ListenerDescription" : "test",
    "ListenerId" : "lsr-bp1bpn0kn908w4nbw****",
    "ListenerPort" : 80,
    "ListenerProtocol" : "HTTP",
    "ListenerStatus" : "active",
    "LoadBalancerId" : "lb-bp1b6c719dfa08ex*****",
    "LogConfig" : {
      "AccessLogRecordCustomizedHeadersEnabled" : true,
      "AccessLogTracingConfig" : {
        "TracingEnabled" : true,
        "TracingSample" : 100,
        "TracingType" : "Zipkin"
      }
    },
    "QuicConfig" : {
      "QuicListenerId" : "lsr-bp1bpn908w4nbw****",
      "QuicUpgradeEnabled" : true
    },
    "RequestTimeout" : 34,
    "SecurityPolicyId" : "tls_cipher_policy_1_1",
    "XForwardedForConfig" : {
      "XForwardedForClientCertClientVerifyAlias" : "test_client-verify-alias_123456",
      "XForwardedForClientCertClientVerifyEnabled" : true,
      "XForwardedForClientCertFingerprintAlias" : "test_finger-print-alias_123456",
      "XForwardedForClientCertFingerprintEnabled" : true,
      "XForwardedForClientCertIssuerDNAlias" : "test_issue-dn-alias_123456",
      "XForwardedForClientCertIssuerDNEnabled" : true,
      "XForwardedForClientCertSubjectDNAlias" : "test_subject-dn-alias_123456",
      "XForwardedForClientCertSubjectDNEnabled" : true,
      "XForwardedForClientSrcPortEnabled" : true,
      "XForwardedForEnabled" : true,
      "XForwardedForProtoEnabled" : true,
      "XForwardedForSLBIdEnabled" : true,
      "XForwardedForSLBPortEnabled" : true
    }
  },
  "MaxResults" : 50,
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId" : "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "TotalCount" : 1000
}

错误码

访问错误中心查看更多错误码。