1. 接口描述
接口请求域名: teo.tencentcloudapi.com 。
通过本接口查询接入多通道安全加速网关的线路。包括直连、EdgeOne 四层代理线路、自定义线路。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeMultiPathGatewayLine。 |
Version | 是 | String | 公共参数,本接口取值:2022-09-01。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
ZoneId | 是 | String | 站点 ID。 |
GatewayId | 是 | String | 网关 ID。 |
LineId | 是 | String | 线路 ID。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Line | MultiPathGatewayLine | 线路信息。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询多通道安全加速网关的直连线路
查询站点(ZoneId 为 zone-27q0p0bal192)下,网关 Id(GatewayId 为 mpgw-lbxuhk1oh),线路类型(LineId 为 line-0)的详细信息。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMultiPathGatewayLine
<公共请求参数>
{
"ZoneId": "zone-27q0p0bal192",
"GatewayId": "mpgw-lbxuhk1oh",
"LineId": "line-0"
}
输出示例
{
"Response": {
"Line": {
"LineId": "line-0",
"LineType": "direct",
"LineAddress": "159.21.35.91:8080"
},
"RequestId": "9153aae4-26b1-4580-adc3-fa7cd4d32bf5"
}
}
示例2 查询多通道安全加速网关的代理线路
查询站点(ZoneId 为 zone-27q0p0bal192)下,网关 Id(GatewayId 为 mpgw-lbxuhk1oh),线路类型(LineId 为 line-1)的详细信息。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMultiPathGatewayLine
<公共请求参数>
{
"ZoneId": "zone-27q0p0bal192",
"GatewayId": "mpgw-lbxuhk1oh",
"LineId": "line-1"
}
输出示例
{
"Response": {
"Line": {
"LineType": "proxy",
"LineAddress": "120.12.31.91:8080",
"LineId": "line-1",
"ProxyId": "sid-2gpv1z8cx8y2",
"RuleId": "rule-33ik84rw3nuu"
},
"RequestId": "9153aae4-26b1-4580-adc3-fa7cd4d32bf5"
}
}
示例3 查询多通道安全加速网关的自定义接入线路
查询站点(ZoneId 为 zone-27q0p0bal192)下,网关 Id(GatewayId 为 mpgw-lbxuhk1oh),线路类型(LineId 为 line-2)的详细信息。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMultiPathGatewayLine
<公共请求参数>
{
"ZoneId": "zone-27q0p0bal192",
"GatewayId": "mpgw-lbxuhk1oh",
"LineId": "line-2"
}
输出示例
{
"Response": {
"Line": {
"LineId": "line-2",
"LineType": "custom",
"LineAddress": "120.12.31.91:8080"
},
"RequestId": "9153aae4-26b1-4580-adc3-fa7cd4d32bf5"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |