You need to enable JavaScript to run this app.
导航
边缘计算节点
  • 文档首页
    • /边缘计算节点/边缘计算节点/API 参考/七层负载均衡/修改监听器配置
修改监听器配置
最近更新时间：2024.07.18 11:03:32首次发布时间：2024.07.02 10:22:47
我的收藏

本接口用于修改监听器的配置。

使用说明

使用限制：
监听协议和端口不能被修改。

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
lb7_identityString是veew-lb79442102222490330****负载均衡实例的 ID。您可以调用 ListLB7Instances 接口查询负载均衡实例的 ID。
listenerListener是见下文说明监听器的配置。

Listener

参数类型是否必选示例值描述
identityString是res-121152522410110****监听器的 ID。您可以调用 ListLB7Listener 接口查询负载均衡实例下的监听器的信息。

name

String

是

listener-http

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

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

x_forwarded_for

Boolean

否

true

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

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

注意

如果已启用“获取客户端 IP”功能但是未指定该参数，“获取客户端 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。单位：秒。
客户端发起请求后，如果在超时时间内没有完成整个请求的传输，负载均衡实例将放弃等待并关闭连接。

desc

String

否

listener01

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

注意

如果不指定该参数，已有的描述会被置为空。

tls_strategy_multi_list

[]TlsStrategyMultiList

否

见下文说明

TLS 安全策略列表。

注意

  • 该参数仅适用于 HTTPS 监听器。
  • 如果配置了 TLS 安全策略但是未指定该参数，TLS 配置会失效。

http2_enabled

Boolean

否

true

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

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

注意

  • 该参数仅适用于 HTTPS 监听器。
  • 如果启用了 HTTP/2 但是未指定该参数，HTTP/2 将会被禁用。

TlsStrategyMultiList

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

version

String

是

v1.0

TLS 版本。取值范围：

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

返回参数

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

请求示例

POST https://veenedge.volcengineapi.com/?Action=EditLB7Listener&Version=2021-04-30
{
    "lb7_identity": "veew-lb70204100444012074****",
    "listener": {
        "identity": "res-5210111041252969****",
        "name": "listener-https",
        "x_forwarded_for": true,
        "idle_timeout": 60,
        "request_timeout": 60,
        "desc": "listener-https-01",
        "tls_strategy_multi_list": [
            {
                "version": "v1.0",
                "encrypt_algo_list": [
                    "ECDHE-ECDSA-AES128-SHA"
                ]
            }
        ],
        "http2_enabled": true
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202406171459242BED1CD6CAE5DB00****",
        "Action": "EditLB7Listener",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {}
}

错误码

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