使用GetListenerAttribute查询网络型负载均衡的监听详情-负载均衡-阿里云

查询网络型负载均衡实例的监听详情。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

nlb:GetListenerAttribute

get

*LoadBalancer

acs:nlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

无

请求参数

名称	类型	必填	描述	示例值
ListenerId	string	是	监听 ID。	lsn-bp1bpn0kn908w4nbw****@233
DryRun	boolean	否	是否只预检此次请求。取值： true：发送检查请求，不会查询监听详情。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。 false（默认值）：发送正常请求，通过检查后返回 HTTP 2xx 状态码并直接进行操作。	false
ClientToken	string	否	客户端 Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。说明若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。	123e4567-e89b-12d3-a456-426655440000
RegionId	string	否	网络型负载均衡实例所在的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	查询监听属性。
RequestId	string	请求 ID。	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
RegionId	string	网络型负载均衡实例所在的地域 ID。	cn-hangzhou
LoadBalancerId	string	网络型负载均衡实例 ID。	nlb-83ckzc8d4xlp8o****
ListenerId	string	监听 ID。	lsn-bp1bpn0kn908w4nbw****@233
ListenerProtocol	string	监听协议。取值：TCP、UDP 或 TCPSSL。	TCPSSL
ListenerPort	integer	监听端口。取值范围：0~65535。0：表示使用全端口监听。当设置为 0 时，您需要配置 StartPort 和 EndPort。	233
StartPort	string	全端口监听起始端口。取值范围：0 ~ 65535。	233
EndPort	string	全端口监听结束端口。取值范围：0~ 65535。结束端口的取值小于起始端口。	455
ListenerDescription	string	自定义监听名称。长度限制为 2~256 个字符，支持中文和英文字母，可包含数字、半角逗号（,）、半角句号（.）、半角分号（;）、正斜线（/）、at（@）、下划线（_）和短划线（-）。	tcpssl_443
ServerGroupId	string	服务器组 ID。	sgp-ppdpc14gdm3x4o****
IdleTimeout	integer	连接空闲超时时间。单位：秒。	900
SecurityPolicyId	string	安全策略 ID。支持系统安全策略和自定义安全策略。系统策略取值：tls_cipher_policy_1_0（默认值）、tls_cipher_policy_1_1、tls_cipher_policy_1_2、tls_cipher_policy_1_2_strict或tls_cipher_policy_1_2_strict_with_1_3。自定义安全策略：输入自定义安全策略 ID。创建自定义策略，请参见 CreateSecurityPolicy 。查询安全策略，请参见 ListSecurityPolicy 。说明仅对 TCPSSL 监听生效。	tls_cipher_policy_1_0
CertificateIds	array	服务器证书列表信息。目前仅支持添加 1 个服务器证书。说明该参数仅对 TCPSSL 监听生效。
	string	服务器证书列表信息。目前仅支持添加 1 个服务器证书。说明该参数仅对 TCPSSL 监听生效。	123157******
CaCertificateIds	array	CA 证书列表信息。目前仅支持添加 1 个 CA 证书。说明该参数仅对 TCPSSL 监听生效。
	string	CA 证书列表信息。目前仅支持添加 1 个 CA 证书。说明该参数仅对 TCPSSL 监听生效。	139a00******
CaEnabled	boolean	是否启动双向认证。取值： true：启动。 false：关闭。	false
AlpnEnabled	boolean	是否开启 ALPN。取值： true：开启。 false：关闭。	false
AlpnPolicy	string	ALPN 策略。取值： HTTP1Only HTTP2Only HTTP2Preferred HTTP2Optional	HTTP1Only
ProxyProtocolEnabled	boolean	是否开启通过 Proxy Protocol 协议携带客户端源地址到后端服务器。取值： true：开启。 false：关闭。	false
ProxyProtocolV2Config	object	通过 Proxy Protocol 协议携带 VpcId、PrivateLinkEpId、PrivateLinkEpsId 信息到后端服务器配置。
Ppv2VpcIdEnabled	boolean	是否开启通过 Proxy Protocol 协议携带 VpcId 到后端服务器。取值： true：开启。 false：关闭。	false
Ppv2PrivateLinkEpIdEnabled	boolean	是否开启通过 Proxy Protocol 协议携带 PrivateLinkEpId 到后端服务器。取值： true：开启。 false：关闭。	false
Ppv2PrivateLinkEpsIdEnabled	boolean	是否开启通过 Proxy Protocol 协议携带 PrivateLinkEpsId 到后端服务器。取值： true：开启。 false：关闭。	false
SecSensorEnabled	boolean	是否开启秒级监控功能。取值： true：开启。 false：关闭。	false
ListenerStatus	string	当前监听的状态，取值： Provisioning：创建中。 Running：运行中。 Configuring：配置中。 Stopping：停止中。 Stopped：已停止。 Starting：启动中。 Deleting：删除中。 Deleted：已删除。	Running
Cps	integer	该监听在每个可用区（VIP）处理的每秒新建连接限速值。取值范围：0~1000000。0 表示不限速。	1000
Mss	integer	TCP 报文的最大段大小。单位：字节，取值范围：0~1500。0 表示不修改用户 TCP 报文的 MSS 值。说明仅 TCP、TCPSSL 类型的监听支持该字段值。	166
Tags	array<object>	标签列表。
	object	标签。
TagKey	string	标签键。	ac-cus-tag-4
TagValue	string	标签值。	ON

示例

正常返回示例

JSON格式

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "RegionId": "cn-hangzhou",
  "LoadBalancerId": "nlb-83ckzc8d4xlp8o****",
  "ListenerId": "lsn-bp1bpn0kn908w4nbw****@233",
  "ListenerProtocol": "TCPSSL",
  "ListenerPort": 233,
  "StartPort": "233",
  "EndPort": "455",
  "ListenerDescription": "tcpssl_443",
  "ServerGroupId": "sgp-ppdpc14gdm3x4o****",
  "IdleTimeout": 900,
  "SecurityPolicyId": "tls_cipher_policy_1_0",
  "CertificateIds": [
    "123157******"
  ],
  "CaCertificateIds": [
    "139a00******"
  ],
  "CaEnabled": false,
  "AlpnEnabled": false,
  "AlpnPolicy": "HTTP1Only",
  "ProxyProtocolEnabled": false,
  "ProxyProtocolV2Config": {
    "Ppv2VpcIdEnabled": false,
    "Ppv2PrivateLinkEpIdEnabled": false,
    "Ppv2PrivateLinkEpsIdEnabled": false
  },
  "SecSensorEnabled": false,
  "ListenerStatus": "Running",
  "Cps": 1000,
  "Mss": 166,
  "Tags": [
    {
      "TagKey": "ac-cus-tag-4",
      "TagValue": "ON"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	SystemBusy	System is busy, please try again later.	系统繁忙，请稍后重试
404	ResourceNotFound.loadBalancer	The specified resource of loadbalancer is not found.	找不到指定的负载均衡器资源，请检查输入参数。
404	ResourceNotFound.listener	The specified resource %s is not found.	资源%s不存在。

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

变更历史

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