调用ListListeners接口查询网络型负载均衡监听列表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ListListeners

系统规定参数。取值：ListListeners。

ListenerIds.N String 否 lsn-bp1bpn0kn908w4nbw****

监听实例ID。最多支持20个监听ID。
LoadBalancerIds.N String 否 nlb-83ckzc8d4xlp8o****

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

监听协议。取值：TCP、UDP或TCPSSL。

NextToken String 否 NextToken FFmyTO70tTpLG6I3FmYAXGKPd****

是否拥有下一次查询的令牌（Token）。取值：

  • 第一次查询和没有下一次查询时，均无需填写。
  • 如果有下一次查询，取值为上一次API调用返回的NextToken值。
MaxResults Integer 否 20

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

RegionId String 否 cn-hangzhou

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

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

返回数据

名称 类型 示例值 描述
RequestId String CEF72CEB-54B6-4AE8-B225-F876FF7BA984

请求ID。
Listeners Array of ListenerInfo

网络型负载均衡监听列表。
LoadBalancerId String nlb-83ckzc8d4xlp8o****

网络型负载均衡实例ID。
ListenerId String lsn-ga6sjjcll6ou34l1et****

监听ID。
ListenerProtocol String TCPSSL

监听协议。取值：TCP、UDP或TCPSSL。

ListenerPort Integer 443

监听端口。
StartPort String 233

全端口监听起始端口。
EndPort String 455

全端口监听结束端口。
ListenerDescription String tcpssl_443

自定义监听名称。

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

服务器组ID。
IdleTimeout Integer 900

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

SecurityPolicyId String tls_cipher_policy_1_1

安全策略ID。

说明 仅对TCPSSL监听生效。
CertificateIds Array of String 12315790212_166f8204689_1714763408_70998****

服务器证书列表信息。

说明 仅对TCPSSL监听生效。
CaCertificateIds Array of String 139a00604ad-cn-east-hangzh****

CA证书列表信息。

说明 仅对TCPSSL监听生效。
CaEnabled Boolean false

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

  • true：启动。
  • false：关闭。
ListenerStatus String Running

当前监听的状态，取值：

  • Provisioning：创建中。
  • Running：运行中。
  • Configuring：配置中。
  • Stopping：停止中。
  • Stopped：已停止。
  • Starting：启动中。
  • Deleting：删除中。
  • Deleted：已删除。
RegionId String cn-hangzhou

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

AlpnEnabled String false

是否开启ALPN。取值：

  • true：开启。
  • false：关闭。
AlpnPolicy String HTTP1Only

ALPN策略。取值：

  • HTTP1Only
  • HTTP2Only
  • HTTP2Preferred
  • HTTP2Optional
SecSensorEnabled String false

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

  • true：开启。
  • false：关闭。
ProxyProtocolEnabled String false

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

  • true：开启。
  • false：关闭。
Cps Integer 1000

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

Mss Integer 200

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

说明 仅TCP、TCPSSL类型的监听支持该字段值。
TotalCount Integer 4

列表条目数。
NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

是否拥有下一次查询的令牌（Token）。取值：

  • 如果NextToken为空表示没有下一次查询。
  • 如果NextToken有返回值，该取值表示下一次查询开始的令牌。
MaxResults Integer 20

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

示例

请求示例

http(s)://[Endpoint]/?Action=ListListeners
&ListenerIds=["lsn-bp1bpn0kn908w4nbw****"]
&LoadBalancerIds=["nlb-83ckzc8d4xlp8o****"]
&ListenerProtocol=TCPSSL
&NextToken=NextToken	FFmyTO70tTpLG6I3FmYAXGKPd****
&MaxResults=20
&RegionId=cn-hangzhou
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<ListListenersResponse>
    <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
    <Listeners>
        <LoadBalancerId>nlb-83ckzc8d4xlp8o****</LoadBalancerId>
        <ListenerId>lsn-ga6sjjcll6ou34l1et****</ListenerId>
        <ListenerProtocol>TCPSSL</ListenerProtocol>
        <ListenerPort>443</ListenerPort>
        <StartPort>233</StartPort>
        <EndPort>455</EndPort>
        <ListenerDescription>tcpssl_443</ListenerDescription>
        <ServerGroupId>sgp-ppdpc14gdm3x4o****</ServerGroupId>
        <IdleTimeout>900</IdleTimeout>
        <SecurityPolicyId>tls_cipher_policy_1_1</SecurityPolicyId>
        <CertificateIds>12315790212_166f8204689_1714763408_70998****</CertificateIds>
        <CaCertificateIds>139a00604ad-cn-east-hangzh****</CaCertificateIds>
        <CaEnabled>false</CaEnabled>
        <ListenerStatus>Running</ListenerStatus>
        <RegionId>cn-hangzhou</RegionId>
        <AlpnEnabled>false</AlpnEnabled>
        <AlpnPolicy>ALPN</AlpnPolicy>
        <SecSensorEnabled>false</SecSensorEnabled>
        <ProxyProtocolEnabled>false</ProxyProtocolEnabled>
        <Cps>1000</Cps>
        <Mss>200</Mss>
    </Listeners>
    <TotalCount>4</TotalCount>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <MaxResults>20</MaxResults>
</ListListenersResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "Listeners" : [ {
    "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" : "ALPN",
    "SecSensorEnabled" : "false",
    "ProxyProtocolEnabled" : "false",
    "Cps" : 1000,
    "Mss" : 200
  } ],
  "TotalCount" : 4,
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults" : 20
}

错误码

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