API 中心
视频服务与安全产品捉虫活动邀您参加！> HOT
文档中心>API 中心>全球应用加速>通道相关接口>查询通道实例列表

查询通道实例列表

最近更新时间：2024-10-23 01:20:59

我的收藏

本页目录：

1. 接口描述

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

本接口（DescribeProxies）用于查询通道实例列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeProxies。
Version 是 String 公共参数，本接口取值：2018-05-29。
Region 否 String 公共参数，本接口不需要传递此参数。
InstanceIds.N 否 Array of String （旧参数，请切换到ProxyIds）按照一个或者多个实例ID查询。每次请求的实例的上限为100。参数不支持同时指定InstanceIds和Filters。
Offset 否 Integer 偏移量，默认为0。
示例值：0
Limit 否 Integer 返回数量，默认为20，最大值为100。
示例值：1
Filters.N 否 Array of Filter 过滤条件。
每次请求的Filters的上限为10，Filter.Values的上限为5。参数不支持同时指定InstanceIds和Filters。
ProjectId - String - 是否必填：否 -（过滤条件）按照项目ID过滤。
AccessRegion - String - 是否必填：否 - （过滤条件）按照接入地域过滤。
RealServerRegion - String - 是否必填：否 - （过滤条件）按照源站地域过滤。
GroupId - String - 是否必填：否 - （过滤条件）按照通道组ID过滤。
IPAddressVersion - String - 是否必填：否 - （过滤条件）按照IP版本过滤。
PackageType - String - 是否必填：否 - （过滤条件）按照通道套餐类型过滤。
ProxyIds.N 否 Array of String （新参数，替代InstanceIds）按照一个或者多个实例ID查询。每次请求的实例的上限为100。参数不支持同时指定InstanceIds和Filters。
示例值：[]
TagSet.N 否 Array of TagPair 标签列表，当存在该字段时，拉取对应标签下的资源列表。
最多支持5个标签，当存在两个或两个以上的标签时，满足其中任意一个标签时，通道会被拉取出来。
Independent 否 Integer 当该字段为1时，仅拉取非通道组的通道，
当该字段为0时，仅拉取通道组的通道，
不存在该字段时，拉取所有通道，包括独立通道和通道组通道。
示例值：1
Order 否 String 输出通道列表的排列顺序。取值范围：
asc：升序排列；
desc：降序排列。
默认为降序。
示例值：desc
OrderField 否 String 通道列表排序的依据字段。取值范围：
create_time：依据通道的创建时间排序；
proxy_id：依据通道的ID排序；
bandwidth：依据通道带宽上限排序；
concurrent_connections：依据通道并发排序；
默认按通道创建时间排序。
示例值：create_time

3. 输出参数

参数名称 类型 描述
TotalCount Integer 通道个数。
示例值：1
InstanceSet Array of ProxyInfo （旧参数，请切换到ProxySet）通道实例信息列表。
ProxySet Array of ProxyInfo （新参数）通道实例信息列表。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询通道实例列表

输入示例

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

{
    "Limit": "1",
    "Offset": "0"
}

输出示例

{
    "Response": {
        "InstanceSet": [
            {
                "AccessRegionInfo": {
                    "RegionId": "Beijing",
                    "RegionAreaName": "NorthChina",
                    "IDCType": "dc",
                    "FeatureBitmap": 79,
                    "RegionArea": "Beijing",
                    "RegionName": "北京（原中国大陆-华北大区）",
                    "SupportFeature": null
                },
                "RelatedGlobalDomains": [],
                "Version": "3.0",
                "PolicyId": null,
                "Scalarable": 1,
                "IPList": [
                    {
                        "IP": "43.137.75.190",
                        "Provider": "BGP",
                        "Bandwidth": 10
                    }
                ],
                "Status": "RUNNING",
                "ProxyType": 100,
                "ForwardIP": "124.222.42.242;118.25.142.34;",
                "ProxyId": "link-4qlu8i3j",
                "RealServerRegion": "Shanghai",
                "Concurrent": 2,
                "RealServerRegionInfo": {
                    "RegionId": "Shanghai",
                    "RegionAreaName": "上海（原中国大陆-华东大区）",
                    "IDCType": "dc",
                    "FeatureBitmap": 79,
                    "RegionArea": "EastChina",
                    "RegionName": "EastChina",
                    "SupportFeature": null
                },
                "IP": "43.137.75.190",
                "Http3Supported": 0,
                "InBanBlacklist": 0,
                "AccessRegion": "Beijing",
                "ProjectId": 1323575,
                "BillingType": 1,
                "SupportProtocols": [
                    "TCP",
                    "UDP"
                ],
                "PackageType": "Thunder",
                "FeatureBitmap": 71,
                "Domain": "link-4qlu8i3j.gaapqcloud.com.c",
                "IPAddressVersion": "IPv4",
                "BanStatus": "RECOVER",
                "CreateTime": 1728542120,
                "InstanceId": "link-4qlu8i3j",
                "Bandwidth": 10,
                "SupportSecurity": 1,
                "TagSet": [
                    {
                        "TagKey": "test-01",
                        "TagValue": "10"
                    }
                ],
                "ClientIPMethod": [
                    0,
                    1
                ],
                "ProxyName": "test-proxy",
                "NetworkType": "normal",
                "ModifyConfigTime": 1728542120,
                "GroupId": null
            }
        ],
        "TotalCount": 1,
        "ProxySet": [
            {
                "AccessRegionInfo": {
                    "RegionId": "Beijing",
                    "RegionAreaName": "NorthChina",
                    "IDCType": "dc",
                    "FeatureBitmap": 79,
                    "RegionArea": "Beijing",
                    "RegionName": "北京（原中国大陆-华北大区）",
                    "SupportFeature": null
                },
                "RelatedGlobalDomains": [],
                "Version": "3.0",
                "PolicyId": null,
                "Scalarable": 1,
                "IPList": [
                    {
                        "IP": "43.137.75.190",
                        "Provider": "BGP",
                        "Bandwidth": 10
                    }
                ],
                "Status": "RUNNING",
                "ProxyType": 100,
                "ForwardIP": "124.222.42.242;118.25.142.34;",
                "ProxyId": "link-4qlu8i3j",
                "RealServerRegion": "Shanghai",
                "Concurrent": 2,
                "RealServerRegionInfo": {
                    "RegionId": "Shanghai",
                    "RegionAreaName": "上海（原中国大陆-华东大区）",
                    "IDCType": "dc",
                    "FeatureBitmap": 79,
                    "RegionArea": "EastChina",
                    "RegionName": "EastChina",
                    "SupportFeature": null
                },
                "IP": "43.137.75.190",
                "Http3Supported": 0,
                "InBanBlacklist": 0,
                "AccessRegion": "Beijing",
                "ProjectId": 1323575,
                "BillingType": 1,
                "SupportProtocols": [
                    "TCP",
                    "UDP",
                    "HTTP",
                    "HTTPS"
                ],
                "PackageType": "Thunder",
                "FeatureBitmap": 71,
                "Domain": "link-4qlu8i3j.gaapqcloud.com.c",
                "IPAddressVersion": "IPv4",
                "BanStatus": "RECOVER",
                "CreateTime": 1728542120,
                "InstanceId": "link-4qlu8i3j",
                "Bandwidth": 10,
                "SupportSecurity": 1,
                "TagSet": [
                    {
                        "TagKey": "test-01",
                        "TagValue": "10"
                    }
                ],
                "ClientIPMethod": [
                    0,
                    1
                ],
                "ProxyName": "test-proxy",
                "NetworkType": "normal",
                "ModifyConfigTime": 1728542120,
                "GroupId": null
            }
        ],
        "RequestId": "bf46572b-700d-4797-831c-7fcf8232358d"
    }
}

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 资源不可用。
ResourceUnavailable.AccountViolation 账号下存在违规资源，详情请查看站内信或邮件。
UnknownParameter 未知参数错误。
中国站
文档反馈
文档活动
message-icon联系我们
目录