创建负载均衡监听器

最近更新时间:2024-03-12 01:29:08

我的收藏

1. 接口描述

接口请求域名: ecm.tencentcloudapi.com 。

创建负载均衡监听器。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateListener。
Version String 公共参数,本接口取值:2019-07-19。
Region String 公共参数,本接口不需要传递此参数。
LoadBalancerId String 负载均衡实例 ID
示例值:lb-f9zyj3kb
Ports.N Array of Integer 要将监听器创建到哪些端口,每个端口对应一个新的监听器
示例值:["13001\n","13002\n","13003\n"]
Protocol String 监听器协议: TCP | UDP
示例值:TCP
ListenerNames.N Array of String 要创建的监听器名称列表,名称与Ports数组按序一一对应,如不需立即命名,则无需提供此参数
示例值:["lis0\n","lis1\n"]
HealthCheck HealthCheck 健康检查相关参数
SessionExpireTime Integer 会话保持时间,单位:秒。可选值:30~3600,默认 0,表示不开启。此参数仅适用于TCP/UDP监听器。
示例值:60
Scheduler String 监听器转发的方式。可选值:WRR、LEAST_CONN
分别表示按权重轮询、最小连接数, 默认为 WRR。
示例值:WRR
SessionType String 会话保持类型。不传或传NORMAL表示默认会话保持类型。QUIC_CID 表示根据Quic Connection ID做会话保持。QUIC_CID只支持UDP协议。
示例值:NORMAL
EndPorts.N Array of Integer 批量端口段的结束端口,必须和Ports长度一样。
示例值:[80,81]

3. 输出参数

参数名称 类型 描述
ListenerIds Array of String 创建的监听器的唯一标识数组
注意:此字段可能返回 null,表示取不到有效值。
示例值:["lbl-knd4jr8m","lbl-2fcyclbg","lbl-m5f7z60y"]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建负载均衡监听器

输入示例

https://ecm.tencentcloudapi.com/?Action=CreateListener
&LoadBalancerId=lb-f9zyj3kb
&Ports.0=13001
&Ports.1=13002
&Ports.2=13003
&Protocol=TCP
&<公共请求参数>

输出示例

{
    "Response": {
        "ListenerIds": [
            "lbl-knd4jr8m",
            "lbl-2fcyclbg",
            "lbl-m5f7z60y"
        ],
        "RequestId": "28b4ba78-0100-4ebe-8afd-a09cf09a6ffe"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.InternalOperationFailure 内部操作错误。
InvalidParameter.FormatError 参数格式错误。
InvalidParameter.InvalidDataFormat 数据格式不正确。
InvalidParameterValue.InvalidPublicParam 公共参数不合法。
InvalidParameterValue.Length 参数长度错误。
LimitExceeded 超过配额限制。
UnauthorizedOperation.ForbiddenOperation 没有权限进行该操作。