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。 direct-connect-tunnel-name, 专用通道名称。 direct-connect-tunnel-id, 专用通道实例ID,如:dcx-abcdefgh。 direct-connect-id, 物理专线实例ID,如:dc-abcdefgh。 示例值:[] |
DirectConnectTunnelIds.N | 否 | Array of String | 专用通道ID数组。 示例值:[] |
Offset | 否 | Integer | 偏移量,默认为0。 示例值:0 |
Limit | 否 | Integer | 返回数量,默认为20,最大值为100。 示例值:20 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DirectConnectTunnelSet | Array of DirectConnectTunnel | 专用通道列表。 示例值:[] |
TotalCount | Integer | 专用通道总数量。 示例值:100 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询BGP路由的专用通道
查询BGP路由的专用通道。
输入示例
https://dc.tencentcloudapi.com/?Action=DescribeDirectConnectTunnels
&Filters.0.Name=direct-connect-tunnel-id
&Filters.0.Values.0=dcx-047zz5e6
&Limit=20
&Offset=0
&<公共请求参数>
输出示例
{
"Response": {
"DirectConnectTunnelSet": [
{
"OwnerAccount": "100001332514",
"DirectConnectOwnerAccount": "100001332514",
"DirectConnectId": "dc-n6c9vvv3",
"SignLaw": true,
"DirectConnectTunnelId": "dcx-047zz5e6",
"DirectConnectTunnelName": "DCXCCNVxlanBgpEcmpTestautotestdcxtwo",
"State": "AVAILABLE",
"VpcId": "",
"NetworkRegion": "ap-chongqing",
"VpcRegion": "cq",
"DirectConnectGatewayId": "dcg-meljxc9n",
"Bandwidth": 100,
"Vlan": 2432,
"TencentAddress": "192.168.0.3/29",
"CustomerAddress": "192.168.0.1/29",
"CreatedTime": "2020-09-22T00:00:00+00:00",
"NetDetectId": "",
"EnableBGPCommunity": false,
"NatType": 0,
"BfdEnable": 0,
"AccessPointType": "VXLAN",
"DirectConnectGatewayName": "",
"VpcName": "",
"ShareOrNot": 0,
"TencentBackupAddress": "192.168.0.2/29",
"NetworkType": "CCN",
"CloudAttachId": null,
"RouteType": "BGP",
"BgpPeer": {
"Asn": 65120,
"AuthKey": "tencent"
},
"RouteFilterPrefixes": [],
"TagSet": []
}
],
"RequestId": "8ae32da8-db96-400f-908e-0de2c89e96ea",
"TotalCount": 1
}
}
示例2 查询STATIC路由的专用通道
查询STATIC路由的专用通道。
输入示例
https://dc.tencentcloudapi.com/?Action=DescribeDirectConnectTunnels
&Filters.0.Name=direct-connect-tunnel-id
&Filters.0.Values.0=dcx-ltcfypom
&Limit=20
&Offset=0
&<公共请求参数>
输出示例
{
"Response": {
"DirectConnectTunnelSet": [
{
"OwnerAccount": "100001332514",
"DirectConnectOwnerAccount": "100001332514",
"DirectConnectId": "dc-n6c9vvv3",
"SignLaw": true,
"DirectConnectTunnelId": "dcx-ltcfypom",
"DirectConnectTunnelName": "DCXVPCVxlanStaticEcmpTestautotestdcxone",
"State": "AVAILABLE",
"VpcId": "vpc-q1cy5hgx",
"NetworkRegion": "ap-chongqing",
"VpcRegion": "cq",
"DirectConnectGatewayId": "dcg-f5ucfdg3",
"Bandwidth": 100,
"Vlan": 2414,
"TencentAddress": "192.168.0.3/29",
"CustomerAddress": "192.168.0.1/29",
"CreatedTime": "2020-09-22T00:00:00+00:00",
"NetDetectId": "",
"EnableBGPCommunity": false,
"NatType": 0,
"BfdEnable": 0,
"AccessPointType": "VXLAN",
"DirectConnectGatewayName": "",
"VpcName": "",
"ShareOrNot": 0,
"TencentBackupAddress": "",
"NetworkType": "VPC",
"CloudAttachId": null,
"RouteType": "STATIC",
"RouteFilterPrefixes": [
{
"Cidr": "19.244.99.224/32"
}
],
"BgpPeer": {
"Asn": -1,
"AuthKey": ""
},
"TagSet": []
}
],
"RequestId": "8ae32da8-db96-400f-908e-0de2c89e96ea",
"TotalCount": 1
}
}
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 | 专用通道不存在。 |