DescribeDirectConnects

Last updated: 2020-05-09 10:01:07

1. API Description

Domain name for API request: dc.tencentcloudapi.com.

This API is used to query the list of connections.

A maximum of 20 requests can be initiated per second for this API.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeDirectConnects.
Version Yes String Common parameter. The value used for this API: 2018-04-10.
Region No String Common parameter. This parameter is not required for this API.
Filters.N No Array of Filter Filter conditions:
DirectConnectIds.N No Array of String Array of connection IDs.
Offset No Integer Offset. Default value: 0.
Limit No Integer Number of returned results. Default value: 20. Maximum value: 100.

3. Output Parameters

Parameter Name Type Description
DirectConnectSet Array of DirectConnect List of connections.
TotalCount Integer Number of eligible connection lists.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the connection list

This example shows you how to use the direct-connect-name filter to filter results.

Input Example

https://dc.tencentcloudapi.com/?Action=DescribeDirectConnects
&Filters.0.Name=direct-connect-name
&Filters.0.Values.0=Direct Connect
&<Common request parameters>

Output Example

{
  "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": "Room 591, Floor 13, Malata Building, Shennan Avenue",
        "CreatedTime": "2018-05-03 15:12:34",
        "PortType": "1000Base-T",
        "CustomerName": "John Smith",
        "LineOperator": "ChinaTelecom",
        "TencentAddress": "192.168.1.2/30",
        "CircuitCode": "",
        "CustomerAddress": "192.168.1.1/30",
        "CustomerContactMail": "zzuzxy1111@163.com",
        "Vlan": 10,
        "Bandwidth": 100,
        "DirectConnectName": "Self-created Direct Connect",
        "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": "Beijing University of Posts and Telecommunications, No.10, Xitucheng Road",
        "CreatedTime": "2018-04-23 11:10:46",
        "PortType": "1000Base-T",
        "CustomerName": "John Smith",
        "LineOperator": "ChinaMobile",
        "TencentAddress": "192.168.1.156/24",
        "CircuitCode": "",
        "CustomerAddress": "192.168.1.157/24",
        "CustomerContactMail": "zzuzxy@163.com",
        "Vlan": 253,
        "Bandwidth": 2,
        "DirectConnectName": "Direct Connect one-time paid test",
        "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": "Room 591, Floor 13, Malata Building",
        "CreatedTime": "2018-04-23 10:28:12",
        "PortType": "1000Base-T",
        "CustomerName": "John Smith",
        "LineOperator": "ChinaMobile",
        "TencentAddress": "192.168.1.2/30",
        "CircuitCode": "",
        "CustomerAddress": "192.168.1.1/30",
        "CustomerContactMail": "zzuzxy@163.com",
        "Vlan": 100,
        "Bandwidth": 2,
        "DirectConnectName": "Direct Connect one-time paid test",
        "ChargeType": "NON_RECURRING_CHARGE",
        "RedundantDirectConnectId": ""
      }
    ],
    "RequestId": "70d690c8-477a-4e5d-99c0-fa1bb012a105",
    "TotalCount": 3
  }
}

Example2 Querying the connection list - 2

This example shows you how to filter the results by direct-connect-name.

Input Example

https://dc.tencentcloudapi.com/?Action=DescribeDirectConnects
&DirectConnectIds.0=dc-6mqd6t9j
&<Common request parameters>

Output Example

{
  "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": "Tencent Building",
        "CreatedTime": "2019-02-28 09:48:39",
        "PortType": "1000Base-LX",
        "CustomerName": "John Smith",
        "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
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error
InvalidParameter Invalid parameter.
InvalidParameterValue Incorrect parameter value.
ResourceNotFound The resource does not exist.
UnauthorizedOperation Unauthorized operation.
UnsupportedOperation Unsupported operation.