AI 助理
文档备案控制台
官方文档
首页 负载均衡 应用型负载均衡ALB 开发参考 API参考 API目录 监听 ListListeners - 查询监听

ListListeners - 查询监听

更新时间：
复制 MD 格式
产品详情
我的收藏

查询指定地域的监听。

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

alb:ListListeners

get

*LoadBalancer

acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

 无 无

请求参数

名称

类型

必填

描述

示例值
NextToken

string

否

是否拥有下一次查询的令牌（Token）。取值：

  • 第一次查询和没有下一次查询时，均无需填写。

  • 如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。

FFmyTO70tTpLG6I4FmYAXGKPd****
MaxResults

integer

否

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

50
ListenerIds

array

否

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

string

否

监听实例 ID。

lsn-o4u54y73wq7b******
LoadBalancerIds

array

否

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

string

否

应用型负载均衡实例 ID。

alb-bd6oylbckp6k9x****
ListenerProtocol

string

否

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

  • HTTP：协议类型为 HTTP。

  • HTTPS：协议类型为 HTTPS。

  • QUIC：协议类型为 QUIC。

HTTP
Tag

array<object>

否

标签。

object

否

标签结构。

Key

string

否

标签键。最多支持 128 个字符，不能以 aliyun 或 acs:开头，不能包含 http://或 https://。

env
Value

string

否

标签值。最多支持 128 个字符，不能以 aliyun 或 acs:开头，不能包含 http://或 https://。

product

返回参数

名称

类型

描述

示例值

object

应用型负载均衡监听信息。

Listeners

array<object>

应用型负载均衡监听列表。

array<object>

应用型负载均衡监听结构。

DefaultActions

array<object>

默认规则动作列表。

array<object>

默认规则动作结构。

ForwardGroupConfig

object

转发规则动作对应的配置。动作类型为 ForwardGroup 时有效。

ServerGroupTuples

array<object>

转发目标服务器组。

object

转发目标服务器组。

ServerGroupId

string

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

sgp-i5qt20******
Type

string

动作类型。取值：ForwardGroup，表示转发至多个服务器组。

ForwardGroup
GzipEnabled

boolean

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

  • true：是。

  • false：否。

false
Http2Enabled

boolean

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

  • true：是。

  • false：否。

说明

仅 HTTPS 监听支持此参数。

false
IdleTimeout

integer

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

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

3
ListenerDescription

string

自定义监听名称。

HTTP_80
ListenerId

string

监听 ID。

lsn-o4u34y73wq7b******
ListenerPort

integer

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

80
ListenerProtocol

string

监听协议。取值：

  • HTTP：协议类型为 HTTP。

  • HTTPS：协议类型为 HTTPS。

  • QUIC：协议类型为 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-o4u54y73wq7b******
QuicUpgradeEnabled

boolean

是否开启 QUIC 升级。取值：

  • true：是。

  • false：否。

说明

仅 HTTPS 监听时有效。

true
RequestTimeout

integer

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

如果在超时时间内后端服务器一直没有响应，负载均衡将放弃等待，给客户端返回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：否。

说明

  1. 配置 true，XForwardedForProcessingMode 默认取值 append，支持修改为 remove。

  2. 配置 false，将请求发送至后端服务之前保留X-Forwarded-For头字段，不做额外处理。

  3. HTTP 和 HTTPS 监听支持此参数。

true
XForwardedForProcessingMode

string

处理X-Forwarded-For头字段的模式。只有当 XForwardedForEnabled 为 true 时，此值才会生效。取值：

  • append（默认值）：附加。

  • remove：删除。

说明

  1. 配置 append，将请求发送至后端服务之前把最后一跳 IP 加入X-Forwarded-For头字段。

  2. 配置 remove，将请求发送至后端服务之前删除X-Forwarded-For标头，无论请求是否携带X-Forwarded-For头字段。

  3. HTTP 和 HTTPS 监听支持此参数。

append
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
XForwardedForHostEnabled

boolean

是否开启通过X-Forwarded-Host头字段获取访问负载均衡实例客户端的域名。取值：

  • true：是。

  • false（默认值）：否。

说明

HTTP、HTTPS 和 QUIC 监听支持此参数。

false
Tags

array<object>

标签。

object

标签结构。

Key

string

标签键。最多支持 128 个字符，不能以 aliyun 或 acs:开头，不能包含 http://或 https://。

env
Value

string

标签值。最多支持 128 个字符，不能以 aliyun 或 acs:开头，不能包含 http://或 https://。

product
MaxResults

integer

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

50
NextToken

string

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

FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId

string

请求 ID。

365F4154-92F6-4AE4-92F8-7FF3******
TotalCount

integer

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

1000

示例

正常返回示例

JSON格式

{
  "Listeners": [
    {
      "DefaultActions": [
        {
          "ForwardGroupConfig": {
            "ServerGroupTuples": [
              {
                "ServerGroupId": "sgp-i5qt20******"
              }
            ]
          },
          "Type": "ForwardGroup"
        }
      ],
      "GzipEnabled": false,
      "Http2Enabled": false,
      "IdleTimeout": 3,
      "ListenerDescription": "HTTP_80",
      "ListenerId": "lsn-o4u34y73wq7b******",
      "ListenerPort": 80,
      "ListenerProtocol": "HTTP",
      "ListenerStatus": "Running",
      "LoadBalancerId": "alb-bd6oylbckp6k9x****",
      "LogConfig": {
        "AccessLogRecordCustomizedHeadersEnabled": true,
        "AccessLogTracingConfig": {
          "TracingEnabled": true,
          "TracingSample": 100,
          "TracingType": "Zipkin"
        }
      },
      "QuicConfig": {
        "QuicListenerId": "lsn-o4u54y73wq7b******",
        "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,
        "XForwardedForProcessingMode": "append",
        "XForwardedForProtoEnabled": true,
        "XForwardedForSLBIdEnabled": true,
        "XForwardedForSLBPortEnabled": true,
        "XForwardedForClientSourceIpsEnabled": false,
        "XForwardedForClientSourceIpsTrusted": "10.1.1.0/24",
        "XForwardedForHostEnabled": false
      },
      "Tags": [
        {
          "Key": "env",
          "Value": "product"
        }
      ]
    }
  ],
  "MaxResults": 50,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF3******",
  "TotalCount": 1000
}

错误码

HTTP status code

错误码

错误信息

描述
403 Forbidden.LoadBalancer Authentication is failed for %s. 负载均衡操作鉴权失败。

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

变更历史

更多信息，参考变更详情。

上一篇：DeleteListener - 删除监听下一篇：StartListener - 启动监听