Action

String

是

AddLBListener

公共参数。该参数表示接口名称。取值：AddLBListener。

Version

String

是

2021-04-30

公共参数。该参数表示接口版本。取值：2021-04-30。

Action

String

是

AddLBListener

公共参数。该参数表示接口名称。取值：AddLBListener。

Version

String

是

2021-04-30

公共参数。该参数表示接口版本。取值：2021-04-30。

lb_identity

String

是

veew-lb2131011027612112****

负载均衡实例的 ID。您可以通过 ListLBs 接口查询负载均衡实例的 ID。

name

String

是

listener-1

监听器的名称。命名规则如下：

• 允许 5~256 个字符。
• 支持中文、大写字母、小写字母、数字。
• 支持特殊字符 ()`~!@#$%^&*-+=_|{}[]:;'<>,.?/。 |
• 不能包含双引号（"）、反斜线（ \）和 空格，且不能以正斜线（/）开头。

listen_port_protocol

String

是

TCP

监听协议，也称前端协议：

• TCP
• UDP

listen_port

Integer

是

80

监听端口，也称前端端口。取值范围：1~65535。

loadbalance_strategy

String

是

sip

负载均衡算法。取值范围：

• sip：源IP一致性哈希。
• sip+sport：源IP+源端口一致性哈希。

endpoints

[]EndpointReq

是

[
  {
    "endpoint_identity": "veen12803802****",
    "endpoint_type": "veen",
    "port": 80,
    "weight": 10
  }
]

后端服务器列表。

health_check

HealthCheck

否

{
  "failure_threshold": 2,
  "http_host": "",
  "http_path": "",
  "http_success_codes": "",
  "period": 10,
  "port": 80,
  "protocol": "TCP",
  "success_threshold": 2,
  "timeout": 10,
  "udp_check_string": "",
  "use_endpoint_port": false
}

健康检查配置。
当您配置了 health_check 参数后，健康检查功能同步开启。

desc

String

否

This is a test

监听器的描述。最多可输入 256 个字符。

default_endpoint_port

Integer

否

80

默认后端端口。默认值：与前端端口相同。取值范围：1~65535。
如需为单个后端服务器配置其他端口，请通过 endpoints 参数进行配置。

idle_timeout

Integer

否

60

连接空闲超时时间。如果已建立的连接上一直没有数据传输且该情况的持续时长达到设置的空闲超时时间时，负载均衡会断开连接。
取值范围： 1 ~ 3600。单位：秒。
默认值：

• TCP： 900。
• UDP： 60。

connection_drain_config

ConnectionDrainConfig

否

{
    "connection_drain_enabled": true,
    "connection_drain_timeout": 360
}

“连接优雅中断”功能配置。
默认情况下，当后端服务器被移除或者健康检查状态异常时，已建立的连接不会立即断开，而是会保持直到连接自然结束或超时。当您开启“连接优雅中断”功能后，负载均衡会在后端服务器被移除或者健康检查状态异常时做以下处理：

• 在指定的“连接优雅中断超时时间”内，允许在已建立的连接上继续正常传输数据。
• 达到指定的“连接优雅中断超时时间”后，主动断开这些连接。