1. 接口描述
接口请求域名： dc.tencentcloudapi.com 。
查询物理专线列表。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDirectConnects。 |
| Version | 是 | String | 公共参数，本接口取值：2018-04-10。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Filters.N | 否 | Array of Filter | 过滤条件。 |
| DirectConnectIds.N | 否 | Array of String | 物理专线 ID数组。 |
| Offset | 否 | Integer | 偏移量，默认为0。 示例值：0 |
| Limit | 否 | Integer | 返回数量，默认为20，最大值为100。 示例值：100 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DirectConnectSet | Array of DirectConnect | 物理专线列表。 |
| TotalCount | Integer | 符合物理专线列表数量。 示例值：100 |
| AllSignLaw | Boolean | 用户名下物理专线是否都签署了用户协议。 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询物理专线列表-1
使用Filter进行筛选，用direct-connect-name进行筛选。
输入示例
https://dc.tencentcloudapi.com/?Action=DescribeDirectConnects
&Filters.0.Name=direct-connect-name
&Filters.0.Values.0=专线接入
&<公共请求参数>输出示例
{
"Response": {
"DirectConnectSet": [
{
"DirectConnectId": "dc-c3hbbsw9",
"DirectConnectName": "专线接入测试",
"RedundantDirectConnectId": "",
"State": "AVAILABLE",
"ChargeState": "NORMAL",
"AccessPointId": "ap-cn-guangzhou-kxc",
"AccessPointName": "广州科丰路",
"AccessPointType": "VXLAN",
"Bandwidth": 10000,
"LineOperator": "ChinaOther",
"Construct": 1,
"Location": "广东省广州市华新园0602-A01机架7号位",
"PortType": "10GBase-LR",
"CreatedTime": "2020-09-22T00:00:00+00:00",
"StartTime": "2019-09-12 17:09:07",
"CircuitCode": "唐镇0103-A09-PL01-1",
"Vlan": 100,
"CustomerName": "张三",
"CustomerContactMail": "zhangsan@tencent.com",
"CustomerContactNumber": "13888888888",
"FaultReportContactPerson": "李四",
"FaultReportContactNumber": "15999999999",
"IdcCity": "广东省广州市华新园0602-A01机架7号位",
"SignLaw": false,
"LocalZone": false,
"VlanZeroDirectConnectTunnelCount": 0,
"OtherVlanDirectConnectTunnelCount": 0,
"MinBandwidth": 0,
"ExpiredTime": null,
"EnabledTime": "2020-09-22T00:00:00+00:00",
"TencentAddress": "192.168.1.2/24",
"CustomerAddress": "192.168.1.1/24",
"ChargeType": "NON_RECURRING_CHARGE",
"TagSet": []
}
],
"RequestId": "edafc0e0-3a01-4ac3-848d-e402ff04c1f3",
"TotalCount": 1,
"AllSignLaw": false
}
}示例2 查询物理专线列表-2
指定DirectConnectIds查询物理专线列表。
输入示例
https://dc.tencentcloudapi.com/?Action=DescribeDirectConnects
&DirectConnectIds.0=dc-c3hbbsw9
&<公共请求参数>输出示例
{
"Response": {
"DirectConnectSet": [
{
"DirectConnectId": "dc-c3hbbsw9",
"DirectConnectName": "专线接入测试",
"RedundantDirectConnectId": "",
"State": "AVAILABLE",
"ChargeState": "NORMAL",
"AccessPointId": "ap-cn-guangzhou-kxc",
"AccessPointName": "广州科丰路",
"AccessPointType": "VXLAN",
"Bandwidth": 10000,
"LineOperator": "ChinaOther",
"Construct": 1,
"Location": "广东省广州市华新园0602-A01机架7号位",
"PortType": "10GBase-LR",
"CreatedTime": "2020-09-22T00:00:00+00:00",
"StartTime": "2019-09-12 17:09:07",
"CircuitCode": "唐镇0103-A09-PL01-1",
"Vlan": 100,
"CustomerName": "张三",
"CustomerContactMail": "zhangsan@tencent.com",
"CustomerContactNumber": "13888888888",
"FaultReportContactPerson": "李四",
"FaultReportContactNumber": "15999999999",
"IdcCity": "广东省广州市华新园0602-A01机架7号位",
"SignLaw": false,
"LocalZone": false,
"VlanZeroDirectConnectTunnelCount": 0,
"OtherVlanDirectConnectTunnelCount": 0,
"MinBandwidth": 0,
"ExpiredTime": null,
"EnabledTime": "2020-09-22T00:00:00+00:00",
"TencentAddress": "192.168.1.2/24",
"CustomerAddress": "192.168.1.1/24",
"ChargeType": "NON_RECURRING_CHARGE",
"TagSet": []
}
],
"RequestId": "edafc0e0-3a01-4ac3-848d-e402ff04c1f3",
"TotalCount": 1,
"AllSignLaw": false
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| ResourceNotFound | 资源不存在。 |
| UnauthorizedOperation | 未授权操作。 |
| UnsupportedOperation | 操作不支持。 |
