DescribeListeners

1. 接口描述

本接口(DescribeListeners)用于本接口接口可根据负载均衡器 ID、监听器的协议作为过滤条件获取监听器列表。如果不指定任何过滤条件，则返回指定负载均衡实例下的所有监听器。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称	必选	类型	描述
loadBalancerId	是	String	负载均衡实例的ID。
listenerIds	否	Array of String	要查询的负载均衡监听器 ID列表。
protocol	否	ListenerProtocol	要查询的监听器协议类型。

3. 响应结果

参数名称	类型	描述
requestId	String	唯一请求 ID。 每次请求都会返回。定位问题时需要提供该次请求的 requestId。
listeners	Array of Listener	监听器列表。

4. 代码示例

示例

1. 查询指定负载均衡实例下所有的监听器。

POST /api/v2/zlb HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeListeners
<Common Request Params>

Request：
{
  "loadBalancerId": "<loadBalancerId>"
}

Response：
{
  "requestId": "TFF2866DD-E3CF-47E4-8B52-D141992D6BB6",
  "response": {
    "listeners": [
      {
        "scheduler": "mh",
        "listenerId": "<loadBalancerId>",
        "protocol": "TCP",
        "port": "40",
        "createTime": "2025-01-01T01:01:01Z",
        "listenerName": "sample-name",
        "kind": "DR",
        "healthCheck": {
          "checkType": null,
          "checkHttpGetUrl": "",
          "checkDelayTry": null,
          "checkConnTimeout": null,
          "checkHttpStatusCode": null,
          "checkPort": null,
          "checkRetry": null,
          "enabled": false,
          "checkDelayLoop": null,
          "failOpen": false,
          "persistent": 60
        }
      }
    ],
    "requestId": "TFF2866DD-E3CF-47E4-8B52-D141992D6BB6"
  }
}

2. 指定监听器和监听协议过滤查询监听器。

POST /api/v2/zlb HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeListeners
<Common Request Params>

Request：
{
  "loadBalancerId": "<loadBalancerId>",
  "protocol": "TCP"
}

Response：
{
  "requestId": "TFF2866DD-E3CF-47E4-8B52-D141992D6BB6",
  "response": {
    "listeners": [
      {
        "scheduler": "mh",
        "listenerId": "<loadBalancerId>",
        "protocol": "TCP",
        "port": "40",
        "createTime": "2025-01-01T01:01:01Z",
        "listenerName": "sample-name",
        "kind": "DR",
        "healthCheck": {
          "checkType": null,
          "checkHttpGetUrl": "",
          "checkDelayTry": null,
          "checkConnTimeout": null,
          "checkHttpStatusCode": null,
          "checkPort": null,
          "checkRetry": null,
          "enabled": false,
          "checkDelayLoop": null,
          "failOpen": false
        }
      }
    ],
    "requestId": "TFF2866DD-E3CF-47E4-8B52-D141992D6BB6"
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码

HTTP状态码	错误码	说明