查询HTTP监听器信息

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

1. 接口描述

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

该接口(DescribeHTTPListeners)用来查询HTTP监听器信息。

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

2. 输入参数

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

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

3. 输出参数

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

4. 示例

示例1 查询HTTP监听器信息

查询HTTP监听器信息

输入示例

https://gaap.tencentcloudapi.com/?Action=DescribeHTTPListeners
&ProxyId=link-n9ha8jzl
&Offset=0
&Limit=20
&<公共请求参数>

输出示例

{
  "Response": {
    "TotalCount": 4,
    "ListenerSet": [
      {
        "Protocol": "HTTP",
        "ListenerId": "listener-4e99n24b",
        "Port": 80,
        "ListenerStatus": 0,
        "ListenerName": "http80",
        "CreateTime": 1563335063
      },
      {
        "Protocol": "HTTP",
        "ListenerId": "listener-jmi21mrf",
        "Port": 8080,
        "ListenerStatus": 0,
        "ListenerName": "http8080",
        "CreateTime": 1564590945
      },
      {
        "Protocol": "HTTP",
        "ListenerId": "listener-1grazsz5",
        "Port": 18080,
        "ListenerStatus": 0,
        "ListenerName": "http18080",
        "CreateTime": 1564590963
      },
      {
        "Protocol": "HTTP",
        "ListenerId": "listener-l6z66uqb",
        "Port": 28080,
        "ListenerStatus": 0,
        "ListenerName": "http28080",
        "CreateTime": 1564640821
      }
    ],
    "RequestId": "4c43a7f7-3527-4e2a-9998-bbd363e4b095"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败
FailedOperation.NotSupportOldVersionProxy 仅支持Version2.0的通道。
FailedOperation.NotSupportProxyGroup 该操作不支持通道组。
InternalError 内部错误
InvalidParameter 参数错误
InvalidParameterValue 参数取值错误
MissingParameter 缺少参数错误
ResourceNotFound 资源不存在
UnauthorizedOperation 未授权操作
UnknownParameter 未知参数错误