CreateListener

1. 接口描述

调用本接口用于在网络型负载均衡实例中创建TCP、UDP或TCPSSL监听。

2. 请求参数

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

参数名称必选类型描述

loadBalancerId

String

负载均衡实例 ID。

listenerName

String

监听器名称。 不得超过64个字符。仅支持输入字母、数字、-和英文句点(.)。

portList

Array of Integer

监听端口。取值范围:0~65535。 示例值:["6569"]

clientToken

String

用于保证请求的幂等性。

protocol

String

监听协议。取值:

  • TCP

  • UDP

backendProtocol

String

后端转发协议。取值:

  • TCP

  • UDP

scheduler

String

调度算法。取值:

  • wrr(默认值):加权轮询,权重值越高的后端服务器,被轮询到的概率也越高。

  • rr:轮询,按照访问顺序依次将外部请求分发到后端服务器。

kind

String

工作模式。取值:

  • NAT

  • DR

healthCheck

健康检查的信息。

notify

警报。

3. 响应结果

参数名称类型描述

requestId

String

唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 requestId。

listenerId

String

监听器的ID。

4. 代码示例

  1. 创建Listener

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

Request:
{
  "loadBalancerId": "xxxx",
  "name": "xxxx",
  "portList": [80],
  "clientToken": "xxxx",
  "protocol": "TCP",
  "backendProtocol": "TCP"
}

Response:
{
  "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
  "response": {
    "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
    "listenerId": "xxxx"
  }
}

5. 开发者工具

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

6. 错误码

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

最后更新于