ListListeners - 查询监听

更新时间: 2023-11-01 19:46:31

查询指定地域的监听。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
alb:ListListenersRead
  • LoadBalancer
    acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

请求参数

名称类型必填描述示例值
NextTokenstring

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

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

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

50
ListenerIdsarray

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

string

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

lsr-bp1bpn0kn908w4nbw****
LoadBalancerIdsarray

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

string

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

alb-bd6oylbckp6k9x****
ListenerProtocolstring

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

  • HTTP:协议类型为HTTP。
  • HTTPS:协议类型为HTTPS。
  • QUIC:协议类型为QUIC。
HTTP
Tagobject []

标签。

Keystring

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

env
Valuestring

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

product

返回参数

名称类型描述示例值
object

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

Listenersobject []

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

DefaultActionsobject []

默认规则动作列表。

ForwardGroupConfigobject

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

ServerGroupTuplesobject []

转发目标服务器组。

ServerGroupIdstring

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

rsp-cige6j****
Typestring

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

ForwardGroup
GzipEnabledboolean

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

  • true:是。
  • false:否。
false
Http2Enabledboolean

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

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

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

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

3
ListenerDescriptionstring

自定义监听名称。

HTTP_80
ListenerIdstring

监听ID。

lsr-bp1bpn0kn908w4nbw****
ListenerPortinteger

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

80
ListenerProtocolstring

监听协议。取值:

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

当前监听的状态,取值:

  • Provisioning:创建中。

  • Running:运行中。

  • Configuring:配置中。

  • Stopped:已停止。

Running
LoadBalancerIdstring

应用型负载均衡实例ID。

alb-bd6oylbckp6k9x****
LogConfigobject

日志配置。

AccessLogRecordCustomizedHeadersEnabledboolean

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

  • true:是。
  • false:否。
true
AccessLogTracingConfigobject

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

TracingEnabledboolean

是否开启Xtrace功能。取值:

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

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

说明 TracingEnabledtrue时,此值有效。
100
TracingTypestring

Xtrace类型,合法取值为Zipkin

说明 TracingEnabledtrue时,此值有效。
Zipkin
QuicConfigobject

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

QuicListenerIdstring

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

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

是否开启QUIC升级。取值:

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

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

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

34
SecurityPolicyIdstring

安全策略。

说明 仅HTTPS监听支持此参数。
tls_cipher_policy_1_1
XForwardedForConfigobject

XForward头字段配置信息。

XForwardedForClientCertClientVerifyAliasstring

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

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

说明 仅HTTPS监听支持此参数。
test_client-verify-alias_123456
XForwardedForClientCertClientVerifyEnabledboolean

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • true:是。
  • false:否。
说明 HTTP和HTTPS监听支持此参数。
true
XForwardedForEnabledboolean

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

  • true:是。
  • false:否。
说明 HTTP和HTTPS监听支持此参数。
true
XForwardedForProtoEnabledboolean

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

  • true:是。
  • false:否。
说明 HTTP、HTTPS和QUIC监听支持此参数。
true
XForwardedForSLBIdEnabledboolean

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

  • true:是。
  • false:否。
说明 HTTP、HTTPS和QUIC监听支持此参数。
true
XForwardedForSLBPortEnabledboolean

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

  • true:是。
  • false:否。
说明 HTTP、HTTPS和QUIC监听支持此参数。
true
XForwardedForClientSourceIpsEnabledboolean

是否通过X-Forwarded-Client-Ip头字段获取访问负载均衡实例的源端口。取值:

  • true:是。

  • false:否。

说明 HTTP、HTTPS和QUIC监听支持此参数。
false
XForwardedForClientSourceIpsTrustedstring

指定可信的代理IP。

应用型负载均衡ALB会从后往前遍历X-Forwarded-For,选取第一个不在可信IP列表中的IP作为真实的客户端IP,该IP会被用于源IP限速。

10.1.1.0/24
Tagsobject []

标签。

Keystring

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

env
Valuestring

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

product
MaxResultsinteger

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

50
NextTokenstring

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

FFmyTO70tTpLG6I3FmYAXGKPd****
RequestIdstring

请求ID。

365F4154-92F6-4AE4-92F8-7FF34B540710
TotalCountinteger

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

1000

示例

正常返回示例

JSON格式

{
  "Listeners": [
    {
      "DefaultActions": [
        {
          "ForwardGroupConfig": {
            "ServerGroupTuples": [
              {
                "ServerGroupId": "rsp-cige6j****"
              }
            ]
          },
          "Type": "ForwardGroup"
        }
      ],
      "GzipEnabled": false,
      "Http2Enabled": false,
      "IdleTimeout": 3,
      "ListenerDescription": "HTTP_80",
      "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
      "ListenerPort": 80,
      "ListenerProtocol": "HTTP",
      "ListenerStatus": "Running",
      "LoadBalancerId": "alb-bd6oylbckp6k9x****",
      "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,
        "XForwardedForClientSourceIpsEnabled": false,
        "XForwardedForClientSourceIpsTrusted": "10.1.1.0/24"
      },
      "Tags": [
        {
          "Key": "env",
          "Value": "product"
        }
      ]
    }
  ],
  "MaxResults": 50,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "TotalCount": 1000
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
阿里云首页 负载均衡 相关技术圈