ModifyListener

1. 接口描述

本接口(ModifyListener)用于修改负载均衡监听器的属性，包括监听器的名称、健康检查参数、转发方式等。不支持修改监听器的监听协议。

2. 请求参数

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

参数名称	必选	类型	描述
loadBalancerId	是	String	负载均衡器ID。
listenerId	是	String	负载均衡器的监听器ID。
listenerName	否	String	负载均衡器的监听器名称。 不传则不会进行修改。
healthCheck	否	HealthCheck	负载均衡器的监听器健康检查。 不传则不会进行修改，如果开启或关闭，请设置HealthCheck.enabled字段。
scheduler	否	ListenerScheduler	负载均衡器的监听器调度方式。 不传则不会进行修改。
port	否	String	监听器端口。 多个端口使用,分隔。 当端口是范围时用-连接，例如：10000-10005。 端口的取值范围为1～65535。 不指定将不会进行修改。
kind	否	LoadBalancerKind	工作模式。 如果修改为DR模式，如果后端服务器指定了端口将失效，将跟随监听器的端口。
persistent	否	Integer	会话保持时间，单位秒。 可选值范围：[0, 3600]。

3. 响应结果

参数名称	类型	描述
requestId	String	唯一请求 ID。 每次请求都会返回。定位问题时需要提供该次请求的 requestId。

4. 代码示例

示例

1. 修改负载均衡监听器的名称、健康检查参数以及转发策略

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

Request：
{
  "loadBalancerId" : "<loadBalancerId>",
  "listenerId" : "<listenerId>",
  "listenerName" : "sampleName",
  "healthCheck" : {
    "enabled": true,
    "checkType": "PING_CHECK",
    "checkPort": null,
    "checkDelayLoop": 4,
    "checkConnTimeout": 3,
    "checkRetry": 4,
    "checkDelayTry": 5,
    "checkHttpGetUrl": "/",
    "checkHttpStatusCode": null
  },
  "scheduler" : "mh"
}

Response：
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3"
  }
}

5. 开发者工具

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

6. 错误码

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

HTTP状态码	错误码	说明
404	INVALID_LB_LISTENER_NOT_FOUND	监听器不存在。
400	INVALID_LISTENER_KIND_NOT_SUPPORT	指定的监听器类型在该区域不支持。
400	INVALID_LISTENER_PERSISTENT_QUOTA_EXCEED	负载均衡器监听器的会话保持时长超过配额。
409	INVALID_LISTENER_PORT_CONFLICT	端口和其他监听器端口冲突。
409	INVALID_LISTENER_PORT_CONFLICT_SELF	当前配置的端口不合法，有冲突。
400	INVALID_PORT_FORMAT_ERROR	端口格式不合法。
400	INVALID_PORT_RANGE	端口范围超出临界值。