帮你快速理解、总结文档立即下载

查询多通道安全加速网关详情

最近更新时间:2026-09-14 02:57:00
我的收藏

1. 接口描述

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

通过本接口查询多通道安全加速网关详情。如名称、网关 ID、IP、端口、类型等。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:DescribeMultiPathGateway。
Version 是 String 公共参数,本接口取值:2022-09-01。
Region 否 String 公共参数,本接口不需要传递此参数。
ZoneId 是 String 站点 ID。
GatewayId 是 String 网关 ID。

3. 输出参数

参数名称 类型 描述
GatewayDetail MultiPathGateway 网关详情。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询云上网关详情

查询站点 ID 为 zone-27q0p0bal192 下,网关 ID 为 mpgw-9d65563y6p 的详细信息。

输入示例

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

{
    "ZoneId": "zone-27q0p0bal192",
    "GatewayId": "mpgw-9d65563y6p"
}

输出示例

{
    "Response": {
        "GatewayDetail": {
            "GatewayId": "mpgw-9d65563y6p",
            "GatewayIP": "49.233.240.134",
            "GatewayName": "EOMPGW-1",
            "GatewayPort": 8080,
            "RegionId": "ap-beijing",
            "Status": "online",
            "GatewayType": "cloud",
            "Lines": [
                {
                    "LineAddress": "49.233.240.134:8080",
                    "LineId": "line-0",
                    "LineType": "direct"
                }
            ]
        },
        "RequestId": "aaab53cb-23c4-4b13-85f5-e63745107ba0"
    }
}

示例2 查询自有网关详情

查询站点 ID 为 zone-27q0p0bal192 下,网关 ID 为 mpgw-9d6asd63376 的详细信息。

输入示例

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

{
    "ZoneId": "zone-27q0p0bal192",
    "GatewayId": "mpgw-9d6asd63376"
}

输出示例

{
    "Response": {
        "GatewayDetail": {
            "GatewayId": "mpgw-9d6asd63376",
            "GatewayIP": "41.125.20.114",
            "GatewayName": "EOMPGW-2",
            "GatewayPort": 8080,
            "RegionId": "ap-shanghai",
            "Status": "online",
            "GatewayType": "private",
            "Lines": [
                {
                    "LineAddress": "43.213.14.191:8080",
                    "LineId": "line-0",
                    "LineType": "direct"
                }
            ]
        },
        "RequestId": "aaab53cb-23c4-4b13-85f5-e63745107ba0"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。