当前位置：主页 > 查看内容

全球应用加速 创建TCP监听器 - API 文档

发布时间：2021-10-12 00:00| 有 位朋友查看

简介：1. 接口描述 接口请求域名： gaap.tencentcloudapi.com 。 该接口（CreateTCPListeners）用于批量创建单通道或者通道组的TCP协议类型的监听器。 默认接口请求频率限制：20次/秒。 推荐使用 API Explorer 点击调试 API Explorer 提供了在线调用、签名验证、SD……

1. 接口描述

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

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

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

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

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版本监听器和通道组监听器。
ClientIPMethod 否 Integer 监听器获取客户端 IP 的方式，0表示 TOA, 1表示Proxy Protocol
FailoverSwitch 否 Integer 源站是否开启主备模式：1开启，0关闭，DOMAIN类型源站不支持开启

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 平台

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

API Inspector

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

SDK

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

  • Tencent Cloud SDK 3.0 for Python
  • Tencent Cloud SDK 3.0 for Java
  • Tencent Cloud SDK 3.0 for PHP
  • Tencent Cloud SDK 3.0 for Go
  • Tencent Cloud SDK 3.0 for NodeJS
  • Tencent Cloud SDK 3.0 for .NET
  • Tencent Cloud SDK 3.0 for C++
  • Tencent Cloud SDK 3.0 for Ruby

命令行工具

  • Tencent Cloud CLI 3.0

6. 错误码

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

错误码 描述
AuthFailure.NotEnterpriseAuthorization 非企业认证客户。
FailedOperation 操作失败。
FailedOperation.DuplicatedRequest 重复的请求，请检查ClientToken的值。
FailedOperation.GroupStatusNotInRuning 通道组状态为非运行状态，无法操作。
FailedOperation.InstanceStatusNotInRuning 通道状态为非运行状态，无法操作。
FailedOperation.LimitNumofListener 监听器数量超过限制。
FailedOperation.ListenerHasTask 监听器正在操作中，请勿重复操作。
FailedOperation.OperateLimitNumofListener 单次操作端口过多，超过数量上限。
FailedOperation.ProxyStatusNotInRuning 通道处于非运行状态，不能添加监听器。
FailedOperation.ResourceUpgrading 资源升级中。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.DuplicatedListenerPort 监听器端口已存在。
InvalidParameterValue.InvalidListenerPort 该监听器端口不可用。
MissingParameter 缺少参数错误。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。

本站部分内容转载于网络，版权归原作者所有，转载之目的在于传播更多优秀技术内容，如有侵权请联系QQ/微信：153890879删除，谢谢！
上一篇：使用示例 - 对象存储 OSS 下一篇：没有了

推荐图文

  • 周排行
  • 月排行
  • 总排行

随机推荐