查询网络型负载均衡监听列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI
Explorer可以自动生成SDK代码示例。
调试
调试
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| nlb:ListListeners | Read |
|
|
无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ListenerIds | array | 否 |
监听实例ID。最多支持20个监听ID。 |
|
| string | 否 |
监听实例ID。最多支持20个监听ID。 |
lsn-bp1bpn0kn908w4nbw**** | |
| LoadBalancerIds | array | 否 |
网络型负载均衡实例ID。最多支持20个实例ID。 |
|
| string | 否 |
网络型负载均衡实例ID。最多支持20个实例ID。 |
nlb-83ckzc8d4xlp8o**** | |
| ListenerProtocol | string | 否 |
监听协议。取值：TCP、UDP或TCPSSL。 |
TCPSSL |
| Tag | object [] | 否 |
标签列表。 |
|
| Key | string | 否 |
实例的标签键。最多支持输入20个标签键。一旦输入该值，则不允许为空字符串。 最多支持64个字符，不能以 |
env |
| Value | string | 否 |
实例的标签值。最多支持输入20个标签值。一旦输入该值，可以为空字符串。 最多支持128个字符，不能以 |
product |
| NextToken | string | 否 |
是否拥有下一次查询的令牌（Token）。取值：
|
NextToken FFmyTO70tTpLG6I3FmYAXGKPd**** |
| MaxResults | integer | 否 |
分批次查询时每次显示的条目数。取值范围：1~100，默认值为20。 |
20 |
| RegionId | string | 否 |
网络型负载均衡实例所在的地域ID。 您可以通过调用DescribeRegions接口获取地域ID。 |
cn-hangzhou |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| object |
查询监听列表。 |
||
| RequestId | string |
请求ID。 |
CEF72CEB-54B6-4AE8-B225-F876FF7BA984 |
| Listeners | object [] |
网络型负载均衡监听列表。 |
|
| Tags | object [] |
标签列表。 |
|
| Key | string |
标签键。 |
Created |
| Value | string |
标签值。 |
TF |
| LoadBalancerId | string |
网络型负载均衡实例ID。 |
nlb-83ckzc8d4xlp8o**** |
| ListenerId | string |
监听ID。 |
lsn-ga6sjjcll6ou34l1et**** |
| ListenerProtocol | string |
监听协议。取值：TCP、UDP或TCPSSL。 |
TCPSSL |
| ListenerPort | integer |
监听端口。 |
443 |
| StartPort | string |
全端口监听起始端口。 |
233 |
| EndPort | string |
全端口监听结束端口。 |
455 |
| ListenerDescription | string |
自定义监听名称。 长度限制为2~256个字符，支持中文和英文字母，可包含数字、半角逗号（,）、半角句号（.）、半角分号（;）、正斜线（/）、at（@）、下划线（_）和短划线（-）。 |
tcpssl_443 |
| ServerGroupId | string |
服务器组ID。 |
sgp-ppdpc14gdm3x4o**** |
| IdleTimeout | integer |
连接空闲超时时间。单位：秒。取值范围：1~900。默认值：900。 |
900 |
| SecurityPolicyId | string |
安全策略ID。 说明 | tls_cipher_policy_1_1 |
| CertificateIds | array | 服务器证书列表信息。 说明 | |
| string | 服务器证书列表信息。 说明 | 12315790212_166f8204689_1714763408_70998**** | |
| CaCertificateIds | array | CA证书列表信息。 说明 | |
| string | CA证书列表信息。 说明 | 139a00604ad-cn-east-hangzh**** | |
| CaEnabled | boolean | 是否启动双向认证。取值：
|
false |
| ListenerStatus | string |
当前监听的状态，取值：
|
Running |
| RegionId | string |
网络型负载均衡实例所在的地域ID。 |
cn-hangzhou |
| AlpnEnabled | boolean |
是否开启ALPN。取值：
|
false |
| AlpnPolicy | string |
ALPN策略。取值：
|
HTTP1Only |
| SecSensorEnabled | boolean |
是否开启秒级监控功能。取值：
|
false |
| ProxyProtocolEnabled | boolean |
是否开启通过Proxy Protocol协议携带客户端源地址到后端服务器。取值：
|
false |
| ProxyProtocolV2Config | object |
通过Proxy Protocol协议携带VpcId、PrivateLinkEpId、PrivateLinkEpsId信息到后端服务器配置。 |
|
| Ppv2VpcIdEnabled | string |
是否开启通过Proxy Protocol协议携带VpcId到后端服务器。取值：
|
false |
| Ppv2PrivateLinkEpIdEnabled | string |
是否开启通过Proxy Protocol协议携带PrivateLinkEpId到后端服务器。取值：
|
false |
| Ppv2PrivateLinkEpsIdEnabled | string |
是否开启通过Proxy Protocol协议携带PrivateLinkEpsId到后端服务器。取值：
|
false |
| Cps | integer |
网络型负载均衡实例每秒新建连接限速值。取值范围：0~1000000。0表示不限速。 |
1000 |
| Mss | integer |
TCP报文的最大段大小。单位：字节，取值范围：0~1500。0表示不修改用户TCP报文的MSS值。 说明 | 200 |
| TotalCount | integer | 列表条目数。 |
4 |
| NextToken | string |
是否拥有下一次查询的令牌（Token）。取值：
|
FFmyTO70tTpLG6I3FmYAXGKPd**** |
| MaxResults | integer |
分批次查询时每次显示的条目数。 |
20 |
示例
正常返回示例
JSON格式
{
"RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
"Listeners": [
{
"Tags": [
{
"Key": "Created",
"Value": "TF"
}
],
"LoadBalancerId": "nlb-83ckzc8d4xlp8o****",
"ListenerId": "lsn-ga6sjjcll6ou34l1et****",
"ListenerProtocol": "TCPSSL",
"ListenerPort": 443,
"StartPort": "233",
"EndPort": "455",
"ListenerDescription": "tcpssl_443",
"ServerGroupId": "sgp-ppdpc14gdm3x4o****",
"IdleTimeout": 900,
"SecurityPolicyId": "tls_cipher_policy_1_1",
"CertificateIds": [
"12315790212_166f8204689_1714763408_70998****"
],
"CaCertificateIds": [
"139a00604ad-cn-east-hangzh****"
],
"CaEnabled": false,
"ListenerStatus": "Running",
"RegionId": "cn-hangzhou",
"AlpnEnabled": false,
"AlpnPolicy": "HTTP1Only",
"SecSensorEnabled": false,
"ProxyProtocolEnabled": false,
"ProxyProtocolV2Config": {
"Ppv2VpcIdEnabled": "false",
"Ppv2PrivateLinkEpIdEnabled": "false",
"Ppv2PrivateLinkEpsIdEnabled": "false"
},
"Cps": 1000,
"Mss": 200
}
],
"TotalCount": 4,
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"MaxResults": 20
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | SystemBusy | System is busy, please try again later. | 系统繁忙，请稍后重试 |
| 403 | Forbidden.NoPermission | Authentication is failed for NoPermission. | 因为账号没有权限，所以鉴权失败。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2023-11-27 | OpenAPI 错误码发生变更，OpenAPI 返回结构发生变更 | 看变更集 | ||||||||
|
||||||||||
| 2023-09-26 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
|
||||||||||
| 2023-09-05 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
|
||||||||||
| 2023-08-22 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
|
||||||||||
| 2023-06-29 | OpenAPI 入参发生变更，OpenAPI 返回结构发生变更 | 看变更集 | ||||||||
|
内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家
阿里云企业补贴进行中： 马上申请
腾讯云限时活动1折起，即将结束： 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折，更有现金返利:同意关联，立享优惠
转转请注明出处：https://www.yunxiaoer.com/168365.html