API 文档

查询TCP监听器列表

最近更新时间:2020-09-02 08:09:55

1. 接口描述

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

该接口(DescribeTCPListeners)用于查询单通道或者通道组下的TCP监听器信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTCPListeners。
Version String 公共参数,本接口取值:2018-05-29。
Region String 公共参数,本接口不需要传递此参数。
ProxyId String 过滤条件,根据通道ID进行拉取,ProxyId/GroupId/ListenerId必须设置一个,但ProxyId和GroupId不能同时设置。
ListenerId String 过滤条件,根据监听器ID精确查询。
当设置了ProxyId时,会检查该监听器是否归属于该通道。
当设置了GroupId时,会检查该监听器是否归属于该通道组。
ListenerName String 过滤条件,根据监听器名称精确查询
Port Integer 过滤条件,根据监听器端口精确查询
Offset Integer 偏移量,默认为0
Limit Integer 限制数量,默认为20
GroupId String 过滤条件,根据通道组ID进行拉取,ProxyId/GroupId/ListenerId必须设置一个,但ProxyId和GroupId不能同时设置。
SearchValue String 过滤条件,支持按照端口或监听器名称进行模糊查询,该参数不能与ListenerName和Port同时使用

3. 输出参数

参数名称 类型 描述
TotalCount Integer 满足条件的监听器总个数
ListenerSet Array of TCPListener TCP监听器列表
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询TCP监听器列表

查询TCP监听器列表

输入示例

https://gaap.tencentcloudapi.com/?Action=DescribeTCPListeners
&ProxyId=link-hwera8lq
&ListenerId=listener-gkzl9e7t
&<公共请求参数>

输出示例

{
  "Response": {
    "TotalCount": 2,
    "ListenerSet": [
      {
        "HealthCheck": 1,
        "Protocol": "TCP",
        "ListenerId": "listener-gkzl9e7t",
        "Port": 111,
        "RealServerType": "IP",
        "RealServerPort": null,
        "DelayLoop": 30,
        "BindStatus": 0,
        "Scheduler": "rr",
        "ListenerStatus": 0,
        "ListenerName": "111",
        "ConnectTimeout": 2,
        "RealServerList": [
          {
            "RealServerWeight": 1,
            "RealServerId": "rs-d2rwammv",
            "RealServerPort": 111,
            "RealServerIP": "a.a.com",
            "RealServerStatus": -1,
            "DownIPList": [
              "11.11.11.11:111"
            ]
          }
        ]
      }
    ],
    "RequestId": "38fab584-8d14-4e2c-988c-4acdabbf2dff"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
ResourceNotFound 资源不存在。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
目录