查询物理专线列表

最近更新时间: 2026-09-17 00:06:03

1. 接口描述

接口请求域名： dc.api3.fincloud.tencent.cn。

查询物理专线列表。

默认接口请求频率限制：20次/秒。

接口更新时间：2024-11-21 09:28:36。

接口既验签名又鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeDirectConnects
Version 是 否 String 公共参数，本接口取值：2018-04-10
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Offset 否 否 Int64 偏移量，默认为0
示例值： 0
Limit 否 否 Int64 返回数量，默认为20，最大值为100
示例值： 100
Filters 否 否 Array of Filter 过滤条件，支持State、专线ID、专线名称、AppId、专线拥有者UIN、是否共享专线进行过滤
示例值：查看
DirectConnectIds 否 否 Array of String 物理专线ID
示例值： dc-m6t1txpp

3. 输出参数

参数名称 类型 描述
DirectConnectSet Array of DirectConnect 物理专线列表。
示例值：查看
TotalCount Int64 符合物理专线列表数量。
示例值： 100
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码 描述
UnauthorizedOperation 未授权操作
UnsupportedOperation 操作不支持。
InternalError 内部错误
InvalidParameterValue 参数取值错误
ResourceNotFound 资源不存在
InvalidParameter 参数错误。

5. 示例

示例1 查询物理专线列表

输入示例

https://dc.api3.{{conf.domain_main}}/?Action=DescribeDirectConnects
&DirectConnectIds.0=dc-6mqd6t9j
&<公共请求参数>

输出示例

{
    "Response": {
        "DirectConnectSet": [
            {
                "EnabledTime": "2019-03-30 09:48:39",
                "CustomerContactNumber": "13924777788",
                "AccessPointId": "ap-cn-test-ns-A",
                "ChargeState": "NORMAL",
                "DirectConnectId": "dc-6mqd6t9j",
                "State": "PENDING",
                "ExpiredTime": null,
                "Location": "开发大厦",
                "CreatedTime": "2019-02-28 09:48:39",
                "PortType": "1000Base-LX",
                "CustomerName": "张三",
                "LineOperator": "Telecom",
                "Private cloudAddress": "",
                "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.api3.{{conf.domain_main}}/?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-test-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": "Telecom",
                "Private cloudAddress": "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-place-hx",
                "ChargeState": "NORMAL",
                "DirectConnectId": "dc-2zeyish1",
                "State": "BUILDING",
                "ExpiredTime": null,
                "Location": "西土城路10号地方邮电大学",
                "CreatedTime": "2018-04-23 11:10:46",
                "PortType": "1000Base-T",
                "CustomerName": "张三",
                "LineOperator": "Mobile",
                "Private cloudAddress": "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-test-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": "Mobile",
                "Private cloudAddress": "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
    }
}