调用GetListenerAttribute查询监听的详细信息。

调试

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

请求参数

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

要执行的操作。

取值:GetListenerAttribute

ListenerId String lsr-bp1bpn0kn908w4nbw****

监听ID。

返回数据

名称 类型 示例值 描述
AclConfig Object

ACL配置结构。

AclRelations Array of aclRelation

监听绑定的访问策略组ID列表。

AclId String acl-doc****

监听绑定的访问策略组ID列表。

Status String Associating

ACL与监听关联的状态:

  • Associating:关联中
  • Associated:已关联
  • Dissociating:解关联中
AclType String White

访问控制类型:

  • White: 仅转发来自所选访问控制策略组中设置的IP地址或地址段的请求,白名单适用于应用只允许特定IP访问的场景。设置白名单存在一定业务风险。一旦设置白名单,就只有白名单中的IP可以访问负载均衡监听。如果开启了白名单访问,但访问策略组中没有添加任何IP,则负载均衡监听会转发全部请求。
  • Black: 来自所选访问控制策略组中设置的IP地址或地址段的所有请求都不会转发,黑名单适用于应用只限制某些特定IP访问的场景。如果开启了黑名单访问,但访问策略组中没有添加任何IP,则负载均衡监听会转发全部请求。
Certificates Array of Certificate

证书列表。

CertificateId String 12315790212_166f8204689_1714763408_70998****

证书ID,当前仅支持服务器证书。

CaEnabled Boolean false

是否开启双向认证。

取值:truefalse

DefaultActions Array of defaultAction

默认规则动作列表。

ForwardGroupConfig Object

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

ServerGroupTuples Array of serverGroupTuple

转发目标服务器组。

ServerGroupId String rsp-cige6j****

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

Type String ForwardGroup

动作类型。

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

GzipEnabled Boolean true

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

取值:truefalse

默认值:true

Http2Enabled Boolean rue

是否开启HTTP/2特性。

取值:truefalse

默认值:true

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

指定连接空闲超时时间。

取值:1~60秒。

默认值:15秒。

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

ListenerDescription String test

监听描述。

ListenerId String lsr-bp1bpn0kn908w4nbw****

监听ID。

ListenerPort Integer 80

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

ListenerProtocol String HTTP

监听协议。

取值:HTTPHTTPSQUIC

ListenerStatus String running

当前监听的状态:

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

负载均衡实例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 lsn-333

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

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

是否开启quic升级。

取值:truefalse

默认值:false

说明 仅HTTPS监听时有效。
RequestId String 365F4154-92F6-4AE4-92F8-7FF34B540710

请求ID。

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监听支持此参数。

示例

请求示例

http(s)://[Endpoint]/?Action=GetListenerAttribute
&ListenerId=lsr-bp1bpn0kn908w4nbw****
&公共请求参数

正常返回示例

XML格式

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

<GetListenerAttributeResponse>
    <AclConfig>
        <AclRelations>
            <AclId>acl-doc****</AclId>
            <Status>Associating</Status>
        </AclRelations>
        <AclType>White</AclType>
    </AclConfig>
    <Certificates>
        <CertificateId>12315790212_166f8204689_1714763408_70998****</CertificateId>
    </Certificates>
    <CaEnabled>false</CaEnabled>
    <DefaultActions>
        <ForwardGroupConfig>
            <ServerGroupTuples>
                <ServerGroupId>rsp-cige6j****</ServerGroupId>
            </ServerGroupTuples>
        </ForwardGroupConfig>
        <Type>ForwardGroup</Type>
    </DefaultActions>
    <GzipEnabled>true</GzipEnabled>
    <Http2Enabled>false</Http2Enabled>
    <IdleTimeout>2</IdleTimeout>
    <ListenerDescription>test</ListenerDescription>
    <ListenerId>lsr-bp1bpn0kn908w4nbw****</ListenerId>
    <ListenerPort>80</ListenerPort>
    <ListenerProtocol>HTTP</ListenerProtocol>
    <ListenerStatus>running</ListenerStatus>
    <LoadBalancerId>lb-12esdf</LoadBalancerId>
    <LogConfig>
        <AccessLogRecordCustomizedHeadersEnabled>true</AccessLogRecordCustomizedHeadersEnabled>
        <AccessLogTracingConfig>
            <TracingEnabled>true</TracingEnabled>
            <TracingSample>100</TracingSample>
            <TracingType>Zipkin</TracingType>
        </AccessLogTracingConfig>
    </LogConfig>
    <QuicConfig>
        <QuicListenerId>lsn-333</QuicListenerId>
        <QuicUpgradeEnabled>true</QuicUpgradeEnabled>
    </QuicConfig>
    <RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
    <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>
</GetListenerAttributeResponse>

JSON格式

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

{
  "AclConfig" : {
    "AclRelations" : {
      "AclId" : "acl-doc****",
      "Status" : "Associating"
    },
    "AclType" : "White"
  },
  "Certificates" : {
    "CertificateId" : "12315790212_166f8204689_1714763408_70998****"
  },
  "CaEnabled" : false,
  "DefaultActions" : {
    "ForwardGroupConfig" : {
      "ServerGroupTuples" : {
        "ServerGroupId" : "rsp-cige6j****"
      }
    },
    "Type" : "ForwardGroup"
  },
  "GzipEnabled" : true,
  "Http2Enabled" : false,
  "IdleTimeout" : 2,
  "ListenerDescription" : "test",
  "ListenerId" : "lsr-bp1bpn0kn908w4nbw****",
  "ListenerPort" : 80,
  "ListenerProtocol" : "HTTP",
  "ListenerStatus" : "running",
  "LoadBalancerId" : "lb-12esdf",
  "LogConfig" : {
    "AccessLogRecordCustomizedHeadersEnabled" : true,
    "AccessLogTracingConfig" : {
      "TracingEnabled" : true,
      "TracingSample" : 100,
      "TracingType" : "Zipkin"
    }
  },
  "QuicConfig" : {
    "QuicListenerId" : "lsn-333",
    "QuicUpgradeEnabled" : true
  },
  "RequestId" : "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "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
  }
}

错误码

HttpCode 错误码 错误信息 描述
404 ResourceNotFound.Listener The specified resource %s is not found. 资源%s不存在。

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