全球应用加速拉取通道组列表-通道组相关接口-API 中心-腾讯云

1. 接口描述

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

本接口（DescribeProxyGroupList）用于拉取通道组列表及各通道组基本信息。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeProxyGroupList。
Version	是	String	公共参数，本接口取值：2018-05-29。
Region	否	String	公共参数，此参数为可选参数。
Offset	是	Integer	偏移量，默认值为0。示例值：0
Limit	是	Integer	返回数量，默认值为20，最大值为100。示例值：20
ProjectId	是	Integer	项目ID。取值范围： -1，该用户下所有项目 0，默认项目其他值，指定的项目示例值：0
Filters.N	否	Array of Filter	过滤条件。每次请求的Filter.Values的上限为5。 RealServerRegion - String - 是否必填：否 -（过滤条件）按照源站地域过滤，可参考DescribeDestRegions接口返回结果中的RegionId。 PackageType - String - 是否必填：否 - （过滤条件）通道组类型，Thunder表示标准通道组，Accelerator表示银牌加速通道组。
TagSet.N	否	Array of TagPair	标签列表，当存在该字段时，拉取对应标签下的资源列表。最多支持5个标签，当存在两个或两个以上的标签时，满足其中任意一个标签时，该通道组会被拉取出来。

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	通道组总数。示例值：2
ProxyGroupList	Array of ProxyGroupInfo	通道组列表。注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询通道组列表

输入示例

https://gaap.tencentcloudapi.com/?Action=DescribeProxyGroupList
&ProjectId=0
&Offset=0
&Limit=20
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 2,
        "RequestId": "8b6bb93c-0dce-4513-a274-1410f276307c",
        "ProxyGroupList": [
            {
                "Status": 0,
                "Domain": null,
                "ProjectId": 0,
                "GroupName": "t4",
                "TagSet": [],
                "RealServerRegionInfo": {
                    "RegionId": "EastChina",
                    "RegionName": "EastChina",
                    "RegionArea": "EastChina",
                    "RegionAreaName": "EastChina",
                    "IDCType": "ec"
                },
                "GroupId": "lg-mh4k07v5"
            },
            {
                "Status": 0,
                "Domain": null,
                "ProjectId": 0,
                "GroupName": "sandytest2",
                "TagSet": [],
                "RealServerRegionInfo": {
                    "RegionId": "EastChina",
                    "RegionName": "EastChina",
                    "RegionArea": "EastChina",
                    "RegionAreaName": "EastChina",
                    "IDCType": "ec"
                },
                "GroupId": "lg-d5y6ei3b"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

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

拉取通道组列表

本页目录：