创建TCP监听器

最近更新时间:2019-08-09 19:18:45

1. 接口描述

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

该接口(CreateTCPListeners)用于批量创建单通道或者通道组的TCP协议类型的监听器。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateTCPListeners
Version String 公共参数,本接口取值:2018-05-29
Region String 公共参数,本接口不需要传递此参数。
ListenerName String 监听器名称。
Ports.N Array of Integer 监听器端口列表。
Scheduler String 监听器源站调度策略,支持轮询(rr),加权轮询(wrr),最小连接数(lc)。
HealthCheck Integer 源站是否开启健康检查:1开启,0关闭,UDP监听器不支持健康检查
RealServerType String 监听器对应源站类型,支持IP或者DOMAIN类型。DOMAIN源站类型不支持wrr的源站调度策略。
ProxyId String 通道ID,ProxyId和GroupId必须设置一个,但不能同时设置。
GroupId String 通道组ID,ProxyId和GroupId必须设置一个,但不能同时设置。
DelayLoop Integer 源站健康检查时间间隔,单位:秒。时间间隔取值在[5,300]之间。
ConnectTimeout Integer 源站健康检查响应超时时间,单位:秒。超时时间取值在[2,60]之间。超时时间应小于健康检查时间间隔DelayLoop。
RealServerPorts.N Array of Integer 源站端口列表,该参数仅支持v1版本监听器和通道组监听器。

3. 输出参数

参数名称 类型 描述
ListenerIds Array of String 返回监听器ID
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建TCP监听器

创建TCP监听器

输入示例

https://gaap.tencentcloudapi.com/?Action=CreateTCPListeners
&ProxyId=link-bjkpdum1
&ListenerName=test1
&RealServerType=IP
&Scheduler=rr
&DelayLoop=20
&ConnectTimeout=20
&HealthCheck=1
&Ports.0=90
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "9aeda369-17c7-429f-be39-745c1e92fc71",
    "ListenerIds": [
      "listener-o0f3at99"
    ]
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败
FailedOperation.DuplicatedRequest 重复的请求,请检查ClientToken的值。
FailedOperation.GroupStatusNotInRuning 通道组状态为非运行状态,无法操作。
FailedOperation.InstanceStatusNotInRuning 通道状态为非运行状态,无法操作。
FailedOperation.LimitNumofListener 监听器数量超过限制。
FailedOperation.ProxyStatusNotInRuning 通道处于非运行状态,不能添加监听器。
InternalError 内部错误
InvalidParameter 参数错误
InvalidParameterValue 参数取值错误
InvalidParameterValue.DuplicatedListenerPort 监听器端口已存在。
InvalidParameterValue.InvalidListenerPort 该监听器端口不可用。
MissingParameter 缺少参数错误
ResourceNotFound 资源不存在
ResourceUnavailable 资源不可用