首页 负载均衡 应用型负载均衡ALB 开发参考 API参考 API目录 监听 GetListenerAttribute - 查询监听器的属性

GetListenerAttribute - 查询监听器的属性

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

查询监听的详细信息。

调试

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

调试

授权信息

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

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

请求参数

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

监听ID。

lsr-bp1bpn0kn908w4nbw****

返回参数

名称类型描述示例值
object

查询监听的详细信息。

AclConfigobject

ACL配置结构。

AclRelationsobject []

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

AclIdstring

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

acl-doc****
Statusstring

ACL与监听关联的状态。取值:

  • Associating:关联中。

  • Associated:已关联。

  • Dissociating:解关联中。

Associating
AclTypestring

访问控制类型。取值:

  • White:仅转发来自所选访问控制策略组中设置的IP地址或地址段的请求,白名单适用于应用只允许特定IP访问的场景。设置白名单存在一定业务风险。一旦设置白名单,就只有白名单中的IP可以访问负载均衡监听。

    如果开启了白名单访问,但访问策略组中没有添加任何IP,则负载均衡监听会转发全部请求。

  • Black:来自所选访问控制策略组中设置的IP地址或地址段的所有请求都不会转发,黑名单适用于应用只限制某些特定IP访问的场景。

    如果开启了黑名单访问,但访问策略组中没有添加任何IP,则负载均衡监听会转发全部请求。

White
Certificatesobject []

证书列表。

CertificateIdstring

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

12315790212_166f8204689_1714763408_70998****
CaCertificatesobject []

监听默认CA证书列表。

CertificateIdstring

监听默认CA证书。

139a00604bd-cn-east-hangzho****
Statusstring

证书状态。

Associated
IsDefaultboolean

是否为默认证书。取值:

  • true:是。

  • false:否。

true
CaEnabledboolean

是否开启双向认证。取值:

  • true:是。
  • false:否。
false
DefaultActionsobject []

默认规则动作列表。

ForwardGroupConfigobject

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

ServerGroupTuplesobject []

转发目标服务器组。

ServerGroupIdstring

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

rsp-cige6j****
Typestring

动作类型。

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

ForwardGroup
GzipEnabledboolean

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

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

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

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

指定连接空闲超时时间。单位:秒。

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

2
ListenerDescriptionstring

自定义监听名称。

HTTP_80
ListenerIdstring

监听ID。

lsr-bp1bpn0kn908w4nbw****
ListenerPortinteger

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

80
ListenerProtocolstring

监听协议。取值:HTTPHTTPSQUIC

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监听之前没有被关联过。
lsn-333
QuicUpgradeEnabledboolean

是否开启QUIC升级。取值:

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

请求ID。

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

指定请求超时时间。单位:秒。

如果在超时时间内后端服务器一直没有响应,负载均衡将放弃等待,给客户端返回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个字符,不能以aliyunacs:开头,不能包含http://https://

env
Valuestring

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

product

示例

正常返回示例

JSON格式

{
  "AclConfig": {
    "AclRelations": [
      {
        "AclId": "acl-doc****",
        "Status": "Associating"
      }
    ],
    "AclType": "White"
  },
  "Certificates": [
    {
      "CertificateId": "12315790212_166f8204689_1714763408_70998****"
    }
  ],
  "CaCertificates": [
    {
      "CertificateId": "139a00604bd-cn-east-hangzho****",
      "Status": "Associated",
      "IsDefault": true
    }
  ],
  "CaEnabled": false,
  "DefaultActions": [
    {
      "ForwardGroupConfig": {
        "ServerGroupTuples": [
          {
            "ServerGroupId": "rsp-cige6j****"
          }
        ]
      },
      "Type": "ForwardGroup"
    }
  ],
  "GzipEnabled": true,
  "Http2Enabled": true,
  "IdleTimeout": 2,
  "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": "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,
    "XForwardedForClientSourceIpsEnabled": false,
    "XForwardedForClientSourceIpsTrusted": "10.1.1.0/24"
  },
  "Tags": [
    {
      "Key": "env",
      "Value": "product"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
404ResourceNotFound.ListenerThe specified resource %s is not found.资源%s不存在。

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

变更历史

变更时间变更内容概要操作
2022-11-18OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
出参OpenAPI 返回结构发生变更
阿里云首页 负载均衡 相关技术圈