查询UDP监听器列表

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

1. 接口描述

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

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

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

2. 输入参数

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

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

3. 输出参数

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

4. 示例

示例1 查询UDP监听器列表

查询UDP监听器列表

输入示例

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

输出示例

{
  "Response": {
    "TotalCount": 2,
    "ListenerSet": [
      {
        "Protocol": "UDP",
        "ListenerId": "listener-pbsgn7ej",
        "Port": 111,
        "RealServerType": "IP",
        "RealServerPort": null,
        "service_status": 0,
        "Scheduler": "rr",
        "ListenerStatus": 0,
        "ListenerName": "111",
        "BindStatus": 0,
        "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 未授权操作