GetListenerAttribute - 查询监听器的属性 - 负载均衡

查询监听的详细信息。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
alb:GetListenerAttribute	Read	LoadBalancer acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}	acs:ResourceTag	无

请求参数

名称	类型	必填	描述	示例值
ListenerId	string	是	监听 ID。	lsn-o4u54y73wq7b******

返回参数

名称	类型	描述	示例值
	object	查询监听的详细信息。
AclConfig	object	ACL 配置结构。
AclRelations	object []	监听绑定的访问策略组 ID 列表。
AclId	string	监听绑定的访问策略组 ID。	acl-doc****
Status	string	ACL 与监听关联的状态。取值： Associating：关联中。 Associated：已关联。 Dissociating：解关联中。	Associating
AclType	string	访问控制类型。取值： White：仅转发来自所选访问控制策略组中设置的 IP 地址或地址段的请求，白名单适用于应用只允许特定 IP 访问的场景。设置白名单存在一定业务风险。一旦设置白名单，就只有白名单中的 IP 可以访问负载均衡监听。如果开启了白名单访问，但访问策略组中没有添加任何 IP，则负载均衡监听会转发全部请求。 Black：来自所选访问控制策略组中设置的 IP 地址或地址段的所有请求都不会转发，黑名单适用于应用只限制某些特定 IP 访问的场景。如果开启了黑名单访问，但访问策略组中没有添加任何 IP，则负载均衡监听会转发全部请求。	White
Certificates	object []	证书列表。
CertificateId	string	证书 ID，当前仅支持服务器证书。	123157*******
CaCertificates	object []	CA 证书列表。
CertificateId	string	CA 证书 ID。	139a00*****
Status	string	证书状态。	Associated
IsDefault	boolean	是否为默认证书。取值： true：是。 false：否。	true
CaEnabled	boolean	是否开启双向认证。取值： true：是。 false：否。	false
DefaultActions	object []	默认规则动作列表。
ForwardGroupConfig	object	转发动作对应的配置，类型为 ForwardGroup 时有效。
ServerGroupTuples	object []	转发目标服务器组。
ServerGroupId	string	转发到的目的服务器组 ID。	sgp-i5qt20******
Type	string	动作类型。取值：ForwardGroup，表示转发至多个服务器组。	ForwardGroup
GzipEnabled	boolean	是否开启 Gzip 压缩，对特定文件类型进行压缩。取值： true：是。 false：否。	true
Http2Enabled	boolean	是否开启 HTTP/2 特性。取值： true：是。 false：否。说明仅 HTTPS 监听支持此参数。	true
IdleTimeout	integer	指定连接空闲超时时间。单位：秒。如果在超时时间内一直没有访问请求，负载均衡会暂时中断当前连接，直到下一次请求来临时重新建立新的连接。	2
ListenerDescription	string	自定义监听名称。	HTTP_80
ListenerId	string	监听 ID。	lsn-o4u54y73wq7b******
ListenerPort	integer	负载均衡实例前端使用的端口。	80
ListenerProtocol	string	监听协议。取值：HTTP、HTTPS 或 QUIC。	HTTP
ListenerStatus	string	当前监听的状态。取值： Provisioning：创建中。 Running：运行中。 Configuring：配置中。 Stopped：已停止。	Running
LoadBalancerId	string	应用型负载均衡实例 ID。	alb-bd6oylbckp6k9x****
LogConfig	object	日志配置信息。
AccessLogRecordCustomizedHeadersEnabled	boolean	访问日志是否开启携带自定义头字段。取值： true：是。 false：否。	true
AccessLogTracingConfig	object	访问日志 Xtrace 相关的配置信息。
TracingEnabled	boolean	Xtrace 功能状态。取值： true：是。 false：否。说明只有实例访问日志开关（AccessLogEnabled）打开时，才能设置为 true。	true
TracingSample	integer	Xtrace 的采样率。取值：1~10000。说明 TracingEnabled 为 true 时，此值有效。	100
TracingType	string	xtrace 的类型。合法取值为 Zipkin。说明 TracingEnabled 为 true 时，此值有效。	Zipkin
QuicConfig	object	启用关联 QUIC 监听时的配置信息。
QuicListenerId	string	需要关联的 QUIC 监听 ID。QuicUpgradeEnabled 为 true 时必选。HTTPS 监听时有效。说明原始监听和关联的 QUIC 监听必须属于同一个 ALB 实例，并且此 QUIC 监听之前没有被关联过。	lsn-ek6ad66t****
QuicUpgradeEnabled	boolean	是否开启 QUIC 升级。取值： true：是。 false：否。说明仅 HTTPS 监听时有效。	true
RequestId	string	请求 ID。	365F4154-92F6-4AE4-92F8-7FF******
RequestTimeout	integer	指定请求超时时间。单位：秒。如果在超时时间内后端服务器一直没有响应，负载均衡将放弃等待，给客户端返回`HTTP 504`错误码。	34
SecurityPolicyId	string	安全策略。说明仅 HTTPS 监听支持此参数。	tls_cipher_policy_1_1
XForwardedForConfig	object	XForward 字段配置信息。
XForwardedForClientCertClientVerifyAlias	string	自定义头名称。只有当 XForwardedForClientCertClientVerifyEnabled 的值为 true 的时候，此值才会生效，否则该值不会生效。取值限制：长度为 1~40 字符。支持字母 a~z、短划线（-）、下划线（_）和数字。说明仅 HTTPS 监听支持此参数。	test_client-verify-alias_123456
XForwardedForClientCertClientVerifyEnabled	boolean	是否通过`X-Forwarded-Clientcert-clientverify`头字段获取访问负载均衡实例客户端证书的校验结果。取值： true：是。 false：否。说明仅 HTTPS 监听支持此参数。	true
XForwardedForClientCertFingerprintAlias	string	自定义头名称，只有当 XForwardedForClientCertFingerprintEnabled 的值为 true 时生效。取值限制：长度为 1~40 字符。支持字母 a~z、短划线（-）、下划线（_）和数字。说明仅 HTTPS 监听支持此参数。	test_finger-print-alias_123456
XForwardedForClientCertFingerprintEnabled	boolean	是否通过`X-Forwarded-Clientcert-fingerprint`头字段获取访问负载均衡实例客户端证书的指纹取值。取值： true：是。 false：否。说明仅 HTTPS 监听支持此参数。	true
XForwardedForClientCertIssuerDNAlias	string	自定义头名称，只有当 XForwardedForClientCertIssuerDNEnabled 的值为 true 的时候，此值才会生效。取值限制：长度为 1~40 字符。支持字母 a~z、短划线（-）、下划线（_）和数字。说明仅 HTTPS 监听支持此参数。	test_issue-dn-alias_123456
XForwardedForClientCertIssuerDNEnabled	boolean	是否通过`X-Forwarded-Clientcert-issuerdn`头字段获取访问负载均衡实例客户端证书的发行者信息。取值： true：是。 false：否。说明仅 HTTPS 监听支持此参数。	true
XForwardedForClientCertSubjectDNAlias	string	自定义头名称，只有当 XForwardedForClientCertSubjectDNEnabled 的值为 true 时，此值才会生效。取值限制：长度为 1~40 字符。支持字母 a~z、短划线（-）、下划线（_）和数字。说明仅 HTTPS 监听支持此参数。	test_subject-dn-alias_123456
XForwardedForClientCertSubjectDNEnabled	boolean	是否通过`X-Forwarded-Clientcert-subjectdn`头字段获取访问负载均衡实例客户端证书的所有者信息。取值： true：是。 false：否。说明仅 HTTPS 监听支持此参数。	true
XForwardedForClientSrcPortEnabled	boolean	是否通过`X-Forwarded-Client-Port`头字段获取访问负载均衡实例客户端的端口。取值： true：是。 false：否。说明 HTTP 和 HTTPS 监听支持此参数。	true
XForwardedForEnabled	boolean	是否开启通过`X-Forwarded-For`头字段获取来访者真实 IP。取值： true：是。 false：否。说明 HTTP 和 HTTPS 监听支持此参数。	true
XForwardedForProtoEnabled	boolean	是否通过`X-Forwarded-Proto`头字段获取负载均衡实例的监听协议。取值： true：是。 false：否。说明 HTTP、HTTPS 和 QUIC 监听支持此参数。	true
XForwardedForSLBIdEnabled	boolean	是否通过`SLB-ID`头字段获取负载均衡实例 ID。取值： true：是。 false：否。说明 HTTP、HTTPS 和 QUIC 监听支持此参数。	true
XForwardedForSLBPortEnabled	boolean	是否通过`X-Forwarded-Port`头字段获取负载均衡实例的监听端口。取值： true：是。 false：否。说明 HTTP、HTTPS 和 QUIC 监听支持此参数。	true
XForwardedForClientSourceIpsEnabled	boolean	是否允许 ALB 从 X-Forwarded-For 头字段中查找真实客户端 IP。取值： true：是。 false：否。说明 HTTP、HTTPS 监听支持此参数。	false
XForwardedForClientSourceIpsTrusted	string	指定可信的代理 IP。应用型负载均衡 ALB 会从后往前遍历`X-Forwarded-For`，选取第一个不在可信 IP 列表中的 IP 作为真实的客户端 IP，该 IP 会被用于源 IP 限速。	10.1.1.0/24
Tags	object []	标签。
Key	string	标签键。最多支持 128 个字符，不能以`aliyun`或`acs:`开头，不能包含`http://`或`https://`。	env
Value	string	标签值。最多支持 128 个字符，不能以`aliyun`或`acs:`开头，不能包含`http://`或`https://`。	product

示例

正常返回示例

JSON格式

{
  "AclConfig": {
    "AclRelations": [
      {
        "AclId": "acl-doc****",
        "Status": "Associating"
      }
    ],
    "AclType": "White"
  },
  "Certificates": [
    {
      "CertificateId": "123157*******"
    }
  ],
  "CaCertificates": [
    {
      "CertificateId": "139a00*****",
      "Status": "Associated",
      "IsDefault": true
    }
  ],
  "CaEnabled": false,
  "DefaultActions": [
    {
      "ForwardGroupConfig": {
        "ServerGroupTuples": [
          {
            "ServerGroupId": "sgp-i5qt20******"
          }
        ]
      },
      "Type": "ForwardGroup"
    }
  ],
  "GzipEnabled": true,
  "Http2Enabled": true,
  "IdleTimeout": 2,
  "ListenerDescription": "HTTP_80",
  "ListenerId": "lsn-o4u54y73wq7b******",
  "ListenerPort": 80,
  "ListenerProtocol": "HTTP",
  "ListenerStatus": "Running",
  "LoadBalancerId": "alb-bd6oylbckp6k9x****",
  "LogConfig": {
    "AccessLogRecordCustomizedHeadersEnabled": true,
    "AccessLogTracingConfig": {
      "TracingEnabled": true,
      "TracingSample": 100,
      "TracingType": "Zipkin"
    }
  },
  "QuicConfig": {
    "QuicListenerId": "lsn-ek6ad66t****",
    "QuicUpgradeEnabled": true
  },
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF******",
  "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,
    "XForwardedForClientSourceIpsEnabled": false,
    "XForwardedForClientSourceIpsTrusted": "10.1.1.0/24"
  },
  "Tags": [
    {
      "Key": "env",
      "Value": "product"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
403	Forbidden.LoadBalancer	Authentication is failed for %s.	负载均衡操作鉴权失败。
404	ResourceNotFound.Listener	The specified resource %s is not found.	资源%s不存在。

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

变更历史

变更时间

变更内容概要

操作

2024-01-29

OpenAPI 错误码发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：404
	新增错误码：403

2022-11-18

OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：404
出参	OpenAPI 返回结构发生变更。