1. 接口描述
接口请求域名: dc.tencentcloudapi.com 。
用于查询专用通道列表。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeDirectConnectTunnels。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-10。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Filters.N | 否 | Array of Filter | 过滤条件: 参数不支持同时指定DirectConnectTunnelIds和Filters。 |
DirectConnectTunnelIds.N | 否 | Array of String | 专用通道 ID数组 |
Offset | 否 | Integer | 偏移量,默认为0 |
Limit | 否 | Integer | 返回数量,默认为20,最大值为100 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DirectConnectTunnelSet | Array of DirectConnectTunnel | 专用通道列表 |
TotalCount | Integer | 符合专用通道数量。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询BGP路由的专用通道
输入示例
https://dc.tencentcloudapi.com/?Action=DescribeDirectConnectTunnels
&Filters.0.Name=direct-connect-tunnel-id
&Filters.0.Values.0=dcx-r3sml04o
&Limit=20
&Offset=1
&<公共请求参数>
输出示例
{
"Response": {
"DirectConnectTunnelSet": [
{
"DirectConnectOwnerAccount": "2407912486",
"DirectConnectGatewayId": "dcg-r70hz833",
"BgpPeer": {
"AuthKey": "tencent",
"Asn": 65139
},
"OwnerAccount": "2407912486",
"DirectConnectId": "dc-9s5kpgyp",
"State": "PENDING",
"TencentAddress": "169.254.64.1/30",
"CreatedTime": "2018-06-01 14:59:16",
"DirectConnectTunnelId": "dcx-r3sml04o",
"NetworkRegion": "ap-guangzhou",
"VpcId": "vpc-aipqhdez",
"CustomerAddress": "169.254.64.2/30",
"Vlan": 1321,
"RouteFilterPrefixes": [],
"NetworkType": "VPC",
"DirectConnectTunnelName": "测试专用通道",
"RouteType": "BGP"
}
]
}
}
示例2 查询STATIC路由的专用通道
输入示例
https://dc.tencentcloudapi.com/?Action=DescribeDirectConnectTunnels
&Filters.0.Name=direct-connect-tunnel-id
&Filters.0.Values.0=dcx-r3sml04o
&Limit=20
&Offset=2
&<公共请求参数>
输出示例
{
"Response": {
"DirectConnectTunnelSet": [
{
"DirectConnectOwnerAccount": "2407912486",
"DirectConnectGatewayId": "dcg-r70hz833",
"BgpPeer": {
"AuthKey": "",
"Asn": -1
},
"OwnerAccount": "2407912486",
"DirectConnectId": "dc-9s5kpgyp",
"State": "PENDING",
"TencentAddress": "169.254.64.1/30",
"CreatedTime": "2018-06-01 14:59:16",
"DirectConnectTunnelId": "dcx-r3sml04o",
"NetworkRegion": "ap-guangzhou",
"VpcId": "vpc-aipqhdez",
"CustomerAddress": "169.254.64.2/30",
"Vlan": 1321,
"RouteFilterPrefixes": [
{
"Cidr": "172.18.27.6/32"
},
{
"Cidr": "172.18.27.0/24"
}
],
"NetworkType": "VPC",
"DirectConnectTunnelName": "测试专用通道",
"RouteType": "STATIC"
}
]
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
AuthFailure.UnauthorizedOperation | CAM签名/鉴权错误,未授权的操作。 |
InternalError | 内部错误。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.DirectConnectTunnelIdIsNotExist | 专用通道不存在。 |