You need to enable JavaScript to run this app.
导航
编辑监听器
最近更新时间:2024.11.29 15:37:36首次发布时间:2022.02.25 18:58:32

本接口用于编辑负载均衡实例的监听器。您可以通过该接口修改监听器的名称、描述、负载均衡策略、和健康检查配置。

请求说明

  • 请求方式:POST
  • 请求地址:https://veenedge.volcengineapi.com?Action=EditLBListener&Version=2021-04-30

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。 其他公共参数,请参见公共参数

Query

参数

类型

是否必选

示例值

描述

Action

String

EditLBListener

公共参数。该参数表示接口名称。取值:EditLBListener。

Version

String

2021-04-30

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

Body

参数

类型

是否必选

示例值

描述

lb_identity

String

veew-lb2131011027612112****

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

listen_port

Integer

80

监听端口。该参数不能修改,用于指定需要修改的监听器。

listen_port_protocol

String

TCP

监听协议。取值范围:

  • TCP
  • UDP

该参数不能修改,用于指定需要修改的监听器。

name

String

listener-1

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

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

loadbalance_strategy

String

sip

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

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

desc

String

test

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

close_health_check

Boolean

false

是否关闭健康检查。取值范围:

  • true:关闭健康检查。
  • false(默认值):不关闭健康检查。

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
}

健康检查配置。

idle_timeout

Integer

60

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

  • TCP: 900
  • UDP: 60

connection_drain_config

ConnectionDrainConfig

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

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

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

返回参数

该接口无特有的返回参数。

请求示例

POST https://veenedge.volcengineapi.com/?Action=EditLBListener&Version=2021-04-30
&<其他公共参数>
{
  "lb_identity": "veew-lb2131011027612112****",
  "listen_port": 80,
  "listen_port_protocol": "TCP",
  "name": "listener-1",
  "close_health_check": true,
  "loadbalance_strategy": "sip"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202305311509582C0B6C9A2AEA21EF****",
        "Action": "EditLBListener",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    }
}

错误码

如果响应正文中包含 Error 字段,则表示 API 请求失败。关于错误码的更多信息,参见错误码