You need to enable JavaScript to run this app.
导航
边缘计算节点
  • 文档首页
    • /边缘计算节点/边缘计算节点/API 参考/七层负载均衡/添加监听器
添加监听器
最近更新时间：2024.08.27 19:06:56首次发布时间：2024.07.02 10:22:47
我的收藏

本接口用于添加监听器。监听器负责监听来自客户端的请求，并依据负载均衡算法将流量转发至后端服务器。

使用说明

使用限制：
一个负载均衡实例下，最多可创建 20 个监听器。

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是AddLB7Listener接口名称。当前 API 的名称为 AddLB7Listener。
VersionString是2021-04-30接口版本。当前 API 的版本为 2021-04-30。

Body

参数类型是否必选示例值描述
lb7_identityString是veew-lb79442102222490330****负载均衡实例的 ID。您可以调用 ListLB7Instances 接口查询负载均衡实例的 ID。

name

String

是

listener-http

监听器的名称。同一负载均衡实例下的监听器的名称必须唯一。命名规则如下：

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

listen_protocol

Integer

是

1

监听协议，也称前端协议。取值范围：

  • 1：HTTP
  • 2：HTTPS
    HTTP 监听器默认支持 WebSocket 协议。HTTPS 监听器默认支持 WebSocket Secure 协议。
listen_portInteger是80监听端口，也称前端端口。在同一个负载均衡实例下，监听端口必须唯一。取值范围：1~65535。

x_forwarded_for

Boolean

否

true

是否启用“获取客户端 IP”功能。该功能允许负载均衡实例通过 X-Forwarded-For 请求头获取客户端的真实 IP 地址。取值范围：

  • true：启用“获取客户端 IP”功能。
  • false（默认值）：禁用“获取客户端 IP”功能。

redirect_to

String

否

res-0094030018300329****

接收重定向请求的 HTTPS 监听器的 ID。您可以调用 ListLB7Listener 接口查询负载均衡实例下的监听器的信息。
如果您需要使用重定向功能，则必须指定该参数。HTTP 监听器和 HTTPS 监听器须属于同一负载均衡实例。此外，须确保 HTTPS 监听器工作正常。

说明

该参数仅适用于 HTTP 监听器。

idle_timeout

Integer

是

60

空闲超时时间。取值范围：1~200。单位：秒。
在超时时间内，如果负载均衡实例一直没有收到新的访问请求，会关闭当前的连接。

request_timeout

Integer

是

60

请求超时时间。取值范围：1~200。单位：秒。
客户端发起请求后，如果在超时时间内没有完成整个请求的传输，负载均衡实例将放弃等待并关闭连接。

descString否listener01监听器的描述信息。最多允许输入 80 个字符。

http2_enabled

Boolean

否

true

是否启用 HTTP/2。取值范围：

  • true：启用 HTTP/2。
  • false（默认值）：禁用 HTTP/2。

说明

该参数仅适用于 HTTPS 监听器。

tls_strategy_multi_list

[]TlsStrategyMultiList

否

见下文说明

TLS 安全策略列表。

说明

该参数仅适用于 HTTPS 监听器。

TlsStrategyMultiList

参数类型是否必选示例值描述

version

String

是

v1.0

TLS 版本。取值范围：

  • v1.0
  • v1.1
  • v1.2
  • v1.3
encrypt_algo_list[]String是ECDHE-ECDSA-AES128-SHA加密算法套件的列表。TLS 版本与加密算法套件的对应关系，请参考 TLS 安全策略。参数值可参考该文档中“支持的加密算法套件”部分的内容。

返回参数

参数类型示例值描述
lb7_listener_identityStringres-121152522410110****监听器的 ID。

请求示例

POST https://veenedge.volcengineapi.com/?Action=AddLB7Listener&Version=2021-04-30
{
    "lb7_identity": "veew-lb70204100444012074****",
    "name": "listener-http",
    "listen_protocol": 1,
    "listen_port": 80,
    "x_forwarded_for": true,
    "redirect_to": "res-5210111041252969****",
    "idle_timeout": 60,
    "request_timeout": 60,
    "desc": "listener-http"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024061416140405267005926F0518****",
        "Action": "AddLB7Listener",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "lb7_listener_identity": "res-4044414421464414****"
    }
}

错误码

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