多网聚合加速（腾讯云聚通）查询客户自有网关集群列表

1. 接口描述

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

查询客户自有网关集群列表。

支持按集群名称关键字过滤，使用 Offset/Limit 分页返回集群及其下网关实例信息。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：GetCustomerGatewayClusterList。
Version	是	String	公共参数，本接口取值：2021-01-19。
Region	否	String	公共参数，此参数为可选参数。
Keyword	否	String	按集群名称模糊匹配的关键字。最大 64 字符。示例值：gateway
PageNumber	否	Integer	当前查看页码。示例值：1
PageSize	否	Integer	每页显示记录数。示例值：10

3. 输出参数

参数名称	类型	描述
ClusterList	Array of GatewayClusterInfo	集群列表。
TotalCount	Integer	集群总数。示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询所有集群

输入示例

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

{}

输出示例

{
    "Response": {
        "ClusterList": [
            {
                "ClusterId": "cluster-vpqultrhw6",
                "ClusterName": "jacky-test-cluster",
                "CreateTime": 1785132647,
                "GatewayList": [
                    {
                        "CreateTime": 1785144,
                        "GatewayId": "mpgw-s6mubb4u11",
                        "GatewayIp": "21.0.***.246",
                        "GatewayName": "multipath-bj-test1-0",
                        "InstanceSize": 4,
                        "RegisterCenterUrl": "reg-*********.multipath.tencent-cloud.com:9300",
                        "Status": 1,
                        "TelemetryUrl": "21.0.21.***:65002",
                        "Token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJTdGFuZGFyZENsYWltcyI6eyJpYX******ODUxNDQxODAuOTU1MjE3LCJuYmYiOjE3ODUxNDQxODAuOTU1MjE3OH0sImd3SWQiOiJtcGd3LXM2bXViYjR1MTEiLCJtZ210SXAiOiIyMS4wLjE3My4yNDYifQ.fvqaWPrJReE6p4S73tdcs1YFJ2UIc-U6YidE-yk6V-4",
                        "Username": "jacky"
                    }
                ],
                "InstanceCount": 1,
                "PublicIp": "39.156.***.229:443"
            }
        ],
        "TotalCount": 1,
        "RequestId": "31159f39-3adc-45cb-87ab-d946abe27067"
    }
}

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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError	内部错误。
InvalidParameter	参数错误。
OperationDenied	操作被拒绝。

查询客户自有网关集群列表

本页目录：