调用 DescribeNLBListeners 接口，查询满足指定条件的监听器。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表中非必选参数均未传入时，返回当前账号下的所有监听器。

Action String 必选示例值：DescribeNLBListeners

要执行的操作，取值为 DescribeNLBListeners。

Version String 必选示例值：2020-04-01

API版本信息，当前版本为 2020-04-01。

LoadBalancerId String 可选示例值：nlb-bp1o94dp5i6ea****

NLB实例ID。

您可以调用DescribeNetworkLoadBalancers接口，获取NLB实例ID。

ListenerIds.N String 可选示例值：lsn-2fek3rgsxhrsw5oxr****

监听器的ID。

参数 - N：表示监听器的序号，取值范围为1 ～ 100。

多个监听器ID之间用&分隔。

ListenerName String 可选示例值：mylistener

监听器的名称。

Protocol String 可选示例值：TCP

监听器的协议。取值如下：

TCP

UDP

TLS

TLS监听器正在邀测中，如需使用，请联系客户经理。

TagFilters.N.Key String 可选示例值：k1

标签的标签键。

参数 - N：表示标签键的序号，取值范围：1～10。

多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与（AND）”，即查询同时添加多个标签键的监听器。

TagFilters.N.Values.N String 可选示例值：v1

标签的标签值。

第一个N：表示标签键的序号。

第二个N：表示标签值的序号，取值范围：1～3。同一标签键多个标签值之间的关系为逻辑“或(OR)”，即查询同一标签键下添加其中一个标签值的监听器。

多个标签值之间用&分隔。

说明

若传入该参数，则必须先传入TagFilters.N.Key。

传入空字符串时，表示查询标签值为空的监听器。

NextToken String 可选示例值：caeba0bbb2be03f84eb48b699f0a****

分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的NextToken参数值。

MaxResults Integer 可选示例值：10

分页查询时每页的行数，取值范围为1 ~ 100，默认值为10。

返回参数

RequestId String 示例值：2024092952539010225146063030****

请求ID。

NextToken String 示例值：caeba0bbb2be03f84eb48b699f0a****

本次调用返回的查询凭证值，返回为空表示没有下一页。

Listeners Object[] 示例值：--

符合条件的监听器的详细信息。

ListenerId String 示例值：lsn-2fek3rgsxhrsw5oxr****

监听器的ID。

ListenerName String 示例值：mylistener

监听器的名称。

LoadBalancerId String 示例值：nlb-bp1o94dp5i6ea****

NLB实例ID。

CreateTime String 示例值：2024-08-11T16:37:37Z

监听器的创建时间。

UpdateTime String 示例值：2024-08-11T16:37:37Z

监听器的最近操作时间。

Description String 示例值：mylistener

监听器的描述。

Status String 示例值：Active

监听器的状态。

Creating：创建中。

Active：运行中。

Deleting: 删除中。

Disabled: 已停用。

Enabled Boolean 示例值：true

是否启用监听器。

true：开启。

false：关闭。

Protocol String 示例值：TCP

监听器的协议。

TCP

UDP

TLS

TLS监听器正在邀测中，如需使用，请联系客户经理。

CertificateSource String 示例值：SSL

服务器证书来源。

SSL：证书中心-SSL 证书。

PCALeaf：证书中心-私有CA 的私有证书。

CertificateId String 示例值：cert-3tjuxoukkq3vj0ww****

默认服务器证书，来源为火山引擎证书中心 SSL 证书。

PCACertificateId String 示例值：pca_leaf_3tjuxo0ww****

默认服务器证书，来源为火山引擎证书中心私有CA 的私有证书。

CAEnabled Boolean 示例值：true

是否开启双向认证。

true：是。

false：否。

CACertificateSource String 示例值：PCARoot

CA证书来源。

PCARoot：私有CA的私有根CA证书。

PCASub：私有CA的私有子CA证书。

CACertificateId String 示例值：pca_root_olkf4tgux9fj0lp***

CA 证书ID。

SecurityPolicyType String 示例值：custom

TLS 安全策略类型。

custom：自定义策略。

system：系统策略。

SecurityPolicyId String 示例值：tls_cipher_policy_1_0

TLS安全策略的ID。

Port Integer 示例值：80

监听器接收请求使用的端口。

0表示启用全端口监听。

StartPort Integer 示例值：80

全端口监听的起始端口。

仅参数Port为0时，返回该参数。

EndPort Integer 示例值：100

全端口监听的结束端口。

仅参数Port为0时，返回该参数。

ServerGroupId String 示例值：rsp-bp1o94dp5i6ea****

监听器关联的服务器组ID。

ConnectionTimeout Integer 示例值：800

监听器的连接超时时间。

Cps Integer 示例值：100

新建连接数限速值。

0 表示不限速。

新建连接数限速功能正在邀测中，如需试用，请联系客户经理。

MaxConnections Integer 示例值：100

并发连接数限速值。

0 表示不限速。

并发连接数限速参数正在邀测中，如需试用，请联系客户经理。

请求示例

返回示例

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

状态码	错误码	错误信息	说明
400	DryRunOperation	Exception raised to indicate a successfully authorized action when the DryRun flag is set to true.	该请求设置为DryRun操作，操作授权已获得许可，但未被实际执行。
400	IdempotentParameterMismatch	Arguments on this idempotent request are inconsistent with arguments used in previous request(s).	此幂等请求的参数与前一个请求中使用的参数不一致。
400	InvalidClientToken.Malformed	The specified ClientToken is malformed.	指定的 ClientToken 参数格式不合法。
400	InvalidIncorrectOrder.Malformed	The specified index order is malformed.	指定的索引顺序参数格式不合法。
400	InvalidListenerName.Malformed	The specified ListenerName is malformed.	指定的 ListenerName 参数格式不合法。
400	InvalidMaxResult.Malformed	The specified MaxResult is malformed.	指定的 MaxResult 参数格式不合法。
400	InvalidMaxResults.Malformed	The specified MaxResults is malformed.	指定的 MaxResults 参数格式不合法。
400	InvalidNextToken.Malformed	The specified NextToken is malformed.	指定的 NextToken 参数格式不合法。
400	InvalidPaging.Malformed	The specified PageNumber or PageSize is malformed.	指定的分页参数格式不合法。
400	InvalidProtocol.Malformed	The specified Protocol is malformed.	指定的 Protocol 参数格式不合法。
400	InvalidTagKey.Malformed	The specified TagKey is malformed.	指定的 TagKey 参数格式不合法。
400	InvalidTagValue.Malformed	The specified TagValue is malformed.	指定的 TagValue 参数格式不合法。
400	LimitExceeded.ListenerId	You've reached the limit on the number of ListenerId that you can operate.	已达到单次可操作监听器的资源数量上限。
400	LimitExceeded.TagFilterKey	You've reached the limit on the number of tag keys that you can filter.	已达到单次可指定过滤标签键数量的上限。
400	LimitExceeded.TagFilterValues	You've reached the limit on the number of tag values that you can filter.	已达到单次可指定过滤标签键值数量的上限。
409	InvalidOperation.Conflict	The specified resource operation conflicts.	指定的资源操作冲突。
412	IdempotentProcessing	The request uses the same client token as a previous one that is still in process.	幂等请求处理中。

负载均衡