查询物理专线列表

最近更新时间:2020-11-18 08:16:57

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
Limit Integer 返回数量,默认为20,最大值为100

3. 输出参数

参数名称 类型 描述
DirectConnectSet Array of DirectConnect 物理专线列表。
TotalCount Integer 符合物理专线列表数量。
AllSignLaw Boolean 用户名下物理专线是否都签署了用户协议
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询物理专线列表-2

输入示例

https://dc.tencentcloudapi.com/?Action=DescribeDirectConnects
&DirectConnectIds.0=dc-6mqd6t9j
&<公共请求参数>

输出示例

{
  "Response": {
    "DirectConnectSet": [
      {
        "EnabledTime": "2019-03-30 09:48:39",
        "CustomerContactNumber": "13924777788",
        "AccessPointId": "ap-cn-shenzhen-ns-A",
        "ChargeState": "NORMAL",
        "DirectConnectId": "dc-6mqd6t9j",
        "State": "PENDING",
        "ExpiredTime": null,
        "Location": "腾讯大厦",
        "CreatedTime": "2019-02-28 09:48:39",
        "PortType": "1000Base-LX",
        "CustomerName": "张三",
        "LineOperator": "ChinaTelecom",
        "TencentAddress": "",
        "CircuitCode": "",
        "CustomerAddress": "",
        "CustomerContactMail": "zzubupt@163.com",
        "Vlan": -1,
        "Bandwidth": 100,
        "DirectConnectName": "bbb",
        "ChargeType": "PREPAID_BY_YEAR",
        "RedundantDirectConnectId": ""
      }
    ],
    "RequestId": "a17e965b-5c58-4cf2-b5fb-2e00946deea8",
    "TotalCount": 1
  }
}

示例2 查询物理专线列表

使用Filter进行筛选,用direct-connect-name进行筛选;

输入示例

https://dc.tencentcloudapi.com/?Action=DescribeDirectConnects
&Filters.0.Name=direct-connect-name
&Filters.0.Values.0=专线接入
&<公共请求参数>

输出示例

{
  "Response": {
    "DirectConnectSet": [
      {
        "EnabledTime": "2018-06-02 15:12:34",
        "CustomerContactNumber": "18812345678",
        "AccessPointId": "ap-cn-shenzhen-ns-A",
        "ChargeState": "NORMAL",
        "DirectConnectId": "dc-gd3u0zov",
        "State": "AVAILABLE",
        "ExpiredTime": null,
        "Location": "深南大道万利达大厦13楼591",
        "CreatedTime": "2018-05-03 15:12:34",
        "PortType": "1000Base-T",
        "CustomerName": "张三",
        "LineOperator": "ChinaTelecom",
        "TencentAddress": "192.168.1.2/30",
        "CircuitCode": "",
        "CustomerAddress": "192.168.1.1/30",
        "CustomerContactMail": "zzuzxy1111@163.com",
        "Vlan": 10,
        "Bandwidth": 100,
        "DirectConnectName": "用户自建专线接入",
        "ChargeType": "NON_RECURRING_CHARGE",
        "RedundantDirectConnectId": ""
      },
      {
        "EnabledTime": "2018-05-23 11:10:46",
        "CustomerContactNumber": "18812345678",
        "AccessPointId": "ap-cn-beijing-hx",
        "ChargeState": "NORMAL",
        "DirectConnectId": "dc-2zeyish1",
        "State": "BUILDING",
        "ExpiredTime": null,
        "Location": "西土城路10号北京邮电大学",
        "CreatedTime": "2018-04-23 11:10:46",
        "PortType": "1000Base-T",
        "CustomerName": "张三",
        "LineOperator": "ChinaMobile",
        "TencentAddress": "192.168.1.156/24",
        "CircuitCode": "",
        "CustomerAddress": "192.168.1.157/24",
        "CustomerContactMail": "zzuzxy@163.com",
        "Vlan": 253,
        "Bandwidth": 2,
        "DirectConnectName": "专线接入一次性付费测试",
        "ChargeType": "PREPAID_BY_YEAR",
        "RedundantDirectConnectId": ""
      },
      {
        "EnabledTime": "2018-05-23 10:28:12",
        "CustomerContactNumber": "18812345678",
        "AccessPointId": "ap-cn-shenzhen-ns-A",
        "ChargeState": "NORMAL",
        "DirectConnectId": "dc-epeq2tj7",
        "State": "BUILDING",
        "ExpiredTime": null,
        "Location": "万利达大厦13楼591房间",
        "CreatedTime": "2018-04-23 10:28:12",
        "PortType": "1000Base-T",
        "CustomerName": "张三",
        "LineOperator": "ChinaMobile",
        "TencentAddress": "192.168.1.2/30",
        "CircuitCode": "",
        "CustomerAddress": "192.168.1.1/30",
        "CustomerContactMail": "zzuzxy@163.com",
        "Vlan": 100,
        "Bandwidth": 2,
        "DirectConnectName": "专线接入一次性付费测试",
        "ChargeType": "NON_RECURRING_CHARGE",
        "RedundantDirectConnectId": ""
      }
    ],
    "RequestId": "70d690c8-477a-4e5d-99c0-fa1bb012a105",
    "TotalCount": 3
  }
}

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 参数取值错误。
ResourceNotFound 资源不存在。
UnauthorizedOperation 未授权操作。
UnsupportedOperation 操作不支持。
目录