文档

ListListeners - 查询监听

更新时间:

查询网络型负载均衡监听列表。

调试

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

授权信息

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

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

请求参数

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

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

string

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

lsn-bp1bpn0kn908w4nbw****
LoadBalancerIdsarray

网络型负载均衡实例 ID。最多支持 20 个实例 ID。

string

网络型负载均衡实例 ID。最多支持 20 个实例 ID。

nlb-83ckzc8d4xlp8o****
ListenerProtocolstring

监听协议。取值:TCPUDPTCPSSL

TCPSSL
Tagobject []

标签列表。

Keystring

实例的标签键。最多支持输入 20 个标签键。一旦输入该值,则不允许为空字符串。

最多支持 64 个字符,不能以aliyunacs:开头,不能包含http://或者https://

env
Valuestring

实例的标签值。最多支持输入 20 个标签值。一旦输入该值,可以为空字符串。

最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

product
NextTokenstring

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

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

分批次查询时每次显示的条目数。取值范围:1~100,默认值为 20

20
RegionIdstring

网络型负载均衡实例所在的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou

返回参数

名称类型描述示例值
object

查询监听列表。

RequestIdstring

请求 ID。

CEF72CEB-54B6-4AE8-B225-F876FF7BA984
Listenersobject []

网络型负载均衡监听列表。

Tagsobject []

标签列表。

Keystring

标签键。

Created
Valuestring

标签值。

TF
LoadBalancerIdstring

网络型负载均衡实例 ID。

nlb-83ckzc8d4xlp8o****
ListenerIdstring

监听 ID。

lsn-ga6sjjcll6ou34l1et****
ListenerProtocolstring

监听协议。取值:TCPUDPTCPSSL

TCPSSL
ListenerPortinteger

监听端口。

443
StartPortstring

全端口监听起始端口。

233
EndPortstring

全端口监听结束端口。

455
ListenerDescriptionstring

自定义监听名称。

长度限制为 2~256 个字符,支持中文和英文字母,可包含数字、半角逗号(,)、半角句号(.)、半角分号(;)、正斜线(/)、at(@)、下划线(_)和短划线(-)。

tcpssl_443
ServerGroupIdstring

服务器组 ID。

sgp-ppdpc14gdm3x4o****
IdleTimeoutinteger

连接空闲超时时间。单位:秒。取值范围:1~900。默认值:900

900
SecurityPolicyIdstring

安全策略 ID。

说明 仅对 TCPSSL 监听生效。
tls_cipher_policy_1_1
CertificateIdsarray

服务器证书列表信息。

说明 仅对 TCPSSL 监听生效。
string

服务器证书列表信息。

说明 仅对 TCPSSL 监听生效。
123157******
CaCertificateIdsarray

CA 证书列表信息。

说明 仅对 TCPSSL 监听生效。
string

CA 证书列表信息。

说明 仅对 TCPSSL 监听生效。
139a00******
CaEnabledboolean

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

  • true:启动。

  • false:关闭。

false
ListenerStatusstring

当前监听的状态,取值:

  • Provisioning:创建中。

  • Running:运行中。

  • Configuring:配置中。

  • Stopping:停止中。

  • Stopped:已停止。

  • Starting:启动中。

  • Deleting:删除中。

  • Deleted:已删除。

Running
RegionIdstring

网络型负载均衡实例所在的地域 ID。

cn-hangzhou
AlpnEnabledboolean

是否开启 ALPN。取值:

  • true:开启。

  • false:关闭。

false
AlpnPolicystring

ALPN 策略。取值:

  • HTTP1Only
  • HTTP2Only
  • HTTP2Preferred
  • HTTP2Optional
HTTP1Only
SecSensorEnabledboolean

是否开启秒级监控功能。取值:

  • true:开启。

  • false:关闭。

false
ProxyProtocolEnabledboolean

是否开启通过 Proxy Protocol 协议携带客户端源地址到后端服务器。取值:

  • true:开启。

  • false:关闭。

false
ProxyProtocolV2Configobject

通过 Proxy Protocol 协议携带 VpcId、PrivateLinkEpId、PrivateLinkEpsId 信息到后端服务器配置。

Ppv2VpcIdEnabledboolean

是否开启通过 Proxy Protocol 协议携带 VpcId 到后端服务器。取值:

  • true:开启。

  • false:关闭。

false
Ppv2PrivateLinkEpIdEnabledboolean

是否开启通过 Proxy Protocol 协议携带 PrivateLinkEpId 到后端服务器。取值:

  • true:开启。

  • false:关闭。

false
Ppv2PrivateLinkEpsIdEnabledboolean

是否开启通过 Proxy Protocol 协议携带 PrivateLinkEpsId 到后端服务器。取值:

  • true:开启。

  • false:关闭。

false
Cpsinteger

网络型负载均衡实例每秒新建连接限速值。取值范围:0~10000000 表示不限速。

1000
Mssinteger

TCP 报文的最大段大小。单位:字节,取值范围:0~15000 表示不修改用户 TCP 报文的 MSS 值。

说明 仅 TCP、TCPSSL 类型的监听支持该字段值。
200
TotalCountinteger

列表条目数。

4
NextTokenstring

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

  • 如果 NextToken 为空表示没有下一次查询。
  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。
FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsinteger

分批次查询时每次显示的条目数。

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": [
        "123157******"
      ],
      "CaCertificateIds": [
        "139a00******"
      ],
      "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错误码错误信息描述
400SystemBusySystem is busy, please try again later.系统繁忙,请稍后重试
400IllegalParamThe param of %s is illegal.输入的参数有值非法,请检查输入。
403Forbidden.NoPermissionAuthentication is failed for NoPermission.因为账号没有权限,所以鉴权失败。

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

变更历史

变更时间变更内容概要操作
2024-02-29OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
2023-12-12OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
出参OpenAPI 返回结构发生变更
2023-11-27OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
出参OpenAPI 返回结构发生变更
2023-09-26OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
    新增错误码:400
2023-09-05OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 403 变更
2023-08-22OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    新增错误码:403
2023-06-29OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Tag
出参OpenAPI 返回结构发生变更