查询通道实例列表

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

1. 接口描述

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

本接口(DescribeProxies)用于查询通道实例列表。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeProxies
Version String 公共参数,本接口取值:2018-05-29
Region String 公共参数,本接口不需要传递此参数。
InstanceIds.N Array of String (旧参数,请切换到ProxyIds)按照一个或者多个实例ID查询。每次请求的实例的上限为100。参数不支持同时指定InstanceIds和Filters。
Offset Integer 偏移量,默认为0。
Limit Integer 返回数量,默认为20,最大值为100。
Filters.N Array of Filter 过滤条件。
每次请求的Filters的上限为10,Filter.Values的上限为5。参数不支持同时指定InstanceIds和Filters。
ProjectId - String - 是否必填:否 -(过滤条件)按照项目ID过滤。
AccessRegion - String - 是否必填:否 - (过滤条件)按照接入地域过滤。
RealServerRegion - String - 是否必填:否 - (过滤条件)按照源站地域过滤。
GroupId - String - 是否必填:否 - (过滤条件)按照通道组ID过滤。
ProxyIds.N Array of String (新参数,替代InstanceIds)按照一个或者多个实例ID查询。每次请求的实例的上限为100。参数不支持同时指定InstanceIds和Filters。
TagSet.N Array of TagPair 标签列表,当存在该字段时,拉取对应标签下的资源列表。
最多支持5个标签,当存在两个或两个以上的标签时,满足其中任意一个标签时,通道会被拉取出来。
Independent Integer 当该字段为1时,仅拉取非通道组的通道,
当该字段为0时,仅拉取通道组的通道,
不存在该字段时,拉取所有通道,包括独立通道和通道组通道。

3. 输出参数

参数名称 类型 描述
TotalCount Integer 通道个数。
InstanceSet Array of ProxyInfo (旧参数,请切换到ProxySet)通道实例信息列表。
ProxySet Array of ProxyInfo (新参数)通道实例信息列表。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询通道实例列表

输入示例

https://gaap.tencentcloudapi.com/?Action=DescribeProxies
&Offset=0
&Limit=1
&Filters.0.Name=AccessRegion
&Filters.0.Values.0=ap-hongkong
&<公共请求参数>

输出示例

{
  "Response": {
    "InstanceSet": [
      {
        "Status": "CREATING",
        "Domain": "",
        "InstanceId": "link-01vm81tj",
        "AccessRegion": "EastChina",
        "ProxyId": "link-01vm81tj",
        "ProjectId": 0,
        "AccessRegionInfo": {
          "RegionId": "EastChina",
          "RegionName": "中国大陆-华东"
        },
        "RealServerRegion": "NorthChina",
        "CreateTime": "2019-03-21 21:33:45",
        "SupportProtocols": [
          "TCP",
          "UDP",
          "HTTP",
          "HTTPS"
        ],
        "Concurrent": 2,
        "Bandwidth": 10,
        "Version": "2.0",
        "PolicyId": null,
        "Scalarable": 1,
        "IP": "",
        "ProxyName": "fff",
        "TagSet": [],
        "GroupId": null,
        "RealServerRegionInfo": {
          "RegionId": "NorthChina",
          "RegionName": "中国大陆-华北"
        }
      }
    ],
    "ProxySet": [
      {
        "Status": "CREATING",
        "Domain": "",
        "InstanceId": "link-01vm81tj",
        "AccessRegion": "EastChina",
        "ProxyId": "link-01vm81tj",
        "ProjectId": 0,
        "AccessRegionInfo": {
          "RegionId": "EastChina",
          "RegionName": "中国大陆-华东"
        },
        "RealServerRegion": "NorthChina",
        "CreateTime": "2019-03-21 21:33:45",
        "SupportProtocols": [
          "TCP",
          "UDP",
          "HTTP",
          "HTTPS"
        ],
        "Concurrent": 2,
        "Bandwidth": 10,
        "Version": "2.0",
        "PolicyId": null,
        "Scalarable": 1,
        "IP": "",
        "ProxyName": "fff",
        "GroupId": null,
        "RealServerRegionInfo": {
          "RegionId": "NorthChina",
          "RegionName": "中国大陆-华北"
        },
        "TagSet": [
          {
            "TagKey": "gaaptest",
            "TagValue": "www"
          }
        ]
      }
    ],
    "TotalCount": 1,
    "RequestId": "1c54137e-e4da-42e1-8565-1bc2d99794a3"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败
InternalError 内部错误
InvalidParameter 参数错误
InvalidParameterValue 参数取值错误
MissingParameter 缺少参数错误
ResourceNotFound 资源不存在
ResourceUnavailable 资源不可用
UnknownParameter 未知参数错误