查询UDP监听器列表

最近更新时间:2024-10-23 01:21:02

我的收藏

1. 接口描述

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

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

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

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

2. 输入参数

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

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

3. 输出参数

参数名称 类型 描述
TotalCount Integer 监听器个数
示例值:2
ListenerSet Array of UDPListener UDP监听器列表
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询UDP监听器列表

输入示例

POST / HTTP/1.1
Host: gaap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUDPListeners
<公共请求参数>

{
    "ProxyId": "link-hwera8lq",
    "ListenerId": "listener-pbsgn7ej"
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "ListenerSet": [
            {
                "RecvContext": "123",
                "RealServerType": "IP",
                "CheckPort": 4000,
                "ListenerId": "listener-pbsgn7ej",
                "ContextType": "TEXT",
                "ListenerName": "test",
                "Port": 2000,
                "BindStatus": 1,
                "FailoverSwitch": 0,
                "CheckType": "PORT",
                "Scheduler": "rr",
                "RealServerSet": [
                    {
                        "RealServerStatus": 0,
                        "RealServerPort": 5000,
                        "RealServerId": "rs-l694mxlf",
                        "RealServerFailoverRole": "master",
                        "DownIPList": [
                            "192.168.1.2:5000"
                        ],
                        "RealServerWeight": 1,
                        "RealServerIP": "192.168.1.2"
                    }
                ],
                "SessionPersist": 1,
                "ConnectTimeout": 2,
                "SendContext": "123",
                "HealthCheck": 1,
                "HealthyThreshold": 1,
                "DelayLoop": 1,
                "ListenerStatus": 0,
                "Protocol": "UDP",
                "RealServerPort": 5000,
                "UnhealthyThreshold": 5,
                "ProxyId": "link-nd8l04ev",
                "GroupId": "",
                "CreateTime": 1723131641
            }
        ],
        "RequestId": "dad2a717-3c7d-444d-8f98-0cca9c897ff3"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.NotEnterpriseAuthorization 非企业认证客户。
AuthFailure.UnauthorizedOperation 子账户未授权操作。
FailedOperation 操作失败。
FailedOperation.UserNotConfirmProtocol 未开通协议。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
ResourceNotFound 资源不存在。
ResourceUnavailable.AccountViolation 账号下存在违规资源,详情请查看站内信或邮件。
UnauthorizedOperation 未授权操作。