API 中心
有奖捉虫：行业应用 & 管理与支持文档专题 HOT
文档中心 > API 中心

修改黑石负载均衡四层监听器

最近更新时间：2024-03-12 01:11:07

我的收藏

本页目录：

1. 接口描述

接口请求域名： bmlb.tencentcloudapi.com 。

修改黑石负载均衡四层监听器。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：ModifyL4Listener。
Version 是 String 公共参数，本接口取值：2018-06-25。
Region 是 String 公共参数，详见产品支持的 地域列表。
LoadBalancerId 是 String 负载均衡实例ID，可通过接口DescribeLoadBalancers查询。
ListenerId 是 String 四层监听器ID。可通过接口DescribeL4Listeners查询。
ListenerName 否 String 四层监听器名称。
SessionExpire 否 Integer 会话保持时间，单位：秒。可选值：900~3600。
HealthSwitch 否 Integer 是否开启健康检查：1（开启）、0（关闭）。默认值0，表示关闭。
TimeOut 否 Integer 健康检查的响应超时时间，可选值：2-60，默认值：2，单位:秒。
响应超时时间要小于检查间隔时间。
IntervalTime 否 Integer 健康检查间隔，默认值：5，可选值：5-300，单位：秒。
HealthNum 否 Integer 健康阈值，默认值：3，表示当连续探测三次健康则表示该转发正常，可选值：2-10，单位：次。
UnhealthNum 否 Integer 不健康阈值，默认值：3，表示当连续探测三次不健康则表示该转发不正常，可选值：2-10，单位：次。
Bandwidth 否 Integer 监听器最大带宽值，用于计费模式为固定带宽计费。可选值：0-1000，单位：Mbps。
CustomHealthSwitch 否 Integer 是否开启自定义健康检查：1（开启）、0（关闭）。默认值0，表示关闭。（该字段在健康检查开启的情况下才生效）
InputType 否 String 自定义健康探测内容类型，可选值：text（文本）、hexadecimal（十六进制）。
LineSeparatorType 否 Integer 探测内容类型为文本方式时，针对请求文本中换行替换方式。可选值：1（替换为LF）、2（替换为CR）、3（替换为LF+CR）。
HealthRequest 否 String 自定义探测请求内容。
HealthResponse 否 String 自定义探测返回内容。
ToaFlag 否 Integer 是否开启toa。可选值：0（关闭）、1（开启），默认关闭。（该字段在负载均衡为fullnat类型下才生效）
BalanceMode 否 String 四层调度方式。wrr，wlc。

3. 输出参数

参数名称 类型 描述
TaskId String 任务ID。该接口为异步任务，可根据本参数调用DescribeLoadBalancerTaskResult接口来查询任务操作结果。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改黑石负载均衡四层监听器

输入示例

https://bmlb.tencentcloudapi.com/?Action=ModifyL4Listener
&LoadBalancerId=lb-dyxceyv5
&ListenerId=lbl-i4go349z
&ListenerName=test_name
&SessionExpire=900
&HealthSwitch=1
&TimeOut=50
&IntervalTime=300
&HealthNum=3
&UnhealthNum=4
&Bandwidth=0
&CustomHealthSwitch=0
&<公共请求参数>

输出示例

{
    "Response": {
        "TaskId": 2385708,
        "RequestId": "6b68aba6-a504-4586-8085-687e0541508f"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
ResourceInUse 资源被占用。
ResourceNotFound 资源不存在。
中国站