Direct Connect
Direct Connect
Document
- Documentation
Direct ConnectAPI ReferenceDC ConnectionDescribeDirectConnectConnectionAttributes - Querying the details of a DC Connection
Copy page
Download PDFDC Connection
DescribeDirectConnectConnectionAttributes - Querying the details of a DC Connection
Copy pageDownload PDFDescribeDirectConnectConnectionAttributes - Querying the details of a DC Connection
Call DescribeDirectConnectConnectionAttributes to query the details of a specified Direct Connect (DC) Connection.
Debug
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
Request parameters
The following only details request parameters specific to this API and key common parameters. For more information, see Common parameters.
Action String required Example: DescribeDirectConnectConnectionAttributes
The interface name. The current API name is DescribeDirectConnectConnectionAttributes.
Version String required Example: 2020-04-01
The interface version. The current API version is 2020-04-01.
DirectConnectConnectionId String required Example: dcc-7qthudw0ll6jmc****
The ID of the DC Connection to be queried. You can call DescribeDirectConnectConnections to query the DC Connection ID.
Response parameters
Only the response parameters specific to this API are listed below. For more information, see Response structure.
ConnectionType String Example: DedicatedConnection
The type of the DC Connection.
- DedicatedConnection: Dedicated Line
- SharedConnection: Shared Line
AccountId String Example: 21000*****
The ID of the account that owns the DC Connection.
DirectConnectConnectionId String Example: dcc-7qthudw0ll6jmc****
The ID of the DC Connection.
- If the DC Connection type is dedicated, the returned value is the ID of the Dedicated Line.
- If the DC Connection type is shared, the returned value is the ID of the Shared Line.
DirectConnectConnectionName String Example: test
The name of the DC Connection.
Description String Example: This is a sample description
The description of the DC Connection.
CreationTime String Example: 2021-04-09T08:36:47+08:00
The time when the DC Connection is created.
UpdateTime String Example: 2021-04-10T09:18:28+08:00
The time when the DC Connection is updated.
PortType String Example: 1000Base
The port type of the DC Connection.
- 1000Base: 1G optical port.
- 10GBase: 10G optical port.
- 40GBase: 40G optical port.
- 100GBase: 100G optical port.
tip
40GBase and 100GBase ports are disabled by default. To request access, please contact your account manager.
Bandwidth Integer Example: 1000
The bandwidth of the DC Connection. Unit: Mbps.
Line Operator String Example: ChinaTelecom
The line operator of the DC Connection.
- ChinaTelecom: China Telecom
- ChinaMobile: China Mobile
- ChinaUnicom: China Unicom
- ChinaOther: Other line operators in China with the corresponding telecommunications business operating license.
DirectConnectAccessPointId String Example: ap-cn-shanghai-***-A
The ID of the DC access point. You can call DescribeDirectConnectAccessPoints to query information about the DC access point.
PeerLocation String Example: Beijing IDC
The peer access point of the DC Connection.
Status String Example: Available
The status of the DC Connection.
- Creating
- Deleting
- Pending: Configuration in progress.
- Available
- Initial: Applying
- Allocated: Under construction
- Rejected: Application rejected
- UnConfirmed: Pending acceptance
- NoPayment: Pending payment
VlanId Integer Example: 1212
The VLAN ID of the Shared Line. If the DC Connection type is dedicated, this parameter returns "0".
ParentConnectionId String Example: dcc-e5z1z57glr0g2yjrzamyw****
The ID of the DC Connection to which the Shared Line belongs. If the DC Connection type is dedicated, this parameter returns an empty string.
ParentConnectionAccountId String Example: 2000956****
The account ID of the DC Connection to which the Shared Line belongs. If the DC Connection type is dedicated, this parameter returns an empty string.
CustomerName String Example: *mei Han
The name of the Direct Connect contact.
CustomerContactPhone String Example: 185****2333
The phone number of the Direct Connect contact.
CustomerContactEmail String Example: exampletest@163.com
The email address of the Direct Connect contact.
Tags Object[] Example: -
All tags added to the DC Connection.
Key String Example: k1
The tag key.
Value String Example: v1
The tag value.
PortSpec String Example: 1G
The port specification of the DC Connection.
BillingType Integer Example: 1
The billing method for Direct Connect. Currently, only "1" (Subscription) is supported.
BusinessStatus String Example: Normal
The billing status of the Direct Connect
- Normal
- FinancialLocked: Being locked.
DeletedTime String Example: 2023-12-02 23:59:59
The time when the resource is scheduled to be forcibly reclaimed.
ExpiredTime String Example: 2023-12-03 12:00:00
The time when the Direct Connect expires.
ExpectBandwidth Integer Example: 500
The expected bandwidth of the DC Connection. Unit: Mbps.
ProjectName String Example: Project_1
The project to which the DC Connection belongs.
DirectConnectTrafficQosPolicyId String Example: dcq-4atoi32cl4c9t0q****
The ID of the QoS policy associated with the DC Connection.
ExpectedExpireShutdownTime String Example: 2024-10-11 12:00:00
The time when the Direct Connect is suspended due to expiration.
AdvanceFeatures Object[] Example: -
Detailed features of the DC Connection.
macsec Boolean Example: false
Describe whether MACsec encryption is supported.
- true: Supported.
- false: Not supported.
IsCloudLinkService Boolean Example: false
Describe whether it is a Cloud Link Service.
- true: Yes.
- false: No.
LineNumber String Example: N9234***
The buliding cable ID for Cloud Link Service.
MacsecCipherSuite String Example: GCM-AES-XPN-256
The encryption suite used by MACsec.
MacsecEncryptionMode String Example: no_encrypt
The encryption mode for MACsec.
- no_encrypt: No encryption.
- should_encrypt: Conditional encryption mode.
- must_encrypt: Mandatory encryption mode.
MacsecKeys Object[] Example: -
The MACsec key information.
Status String Example: Available
The status of the MACsec key.
- Creating
- Available
- Pending: Configuration in progress.
- Deleting
KeyName String Example: macsec-key-1
The name of the MACsec key.
StartOn String Example: 2026-04-13T19:40:53+08:00
The time when the MACsec key is created.
Request example
GET /?Action=DescribeDirectConnectConnectionAttributes&Version=2020-04-01&DirectConnectConnectionId=dcc-7qthudw0ll6jmc**** HTTP/1.1
Host: directconnect.cn-beijing.volcengineapi.com
X-Date: 20250804T033538Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250804/cn-beijing/directconnect/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
Response example
{
"ResponseMetadata": {
"RequestId": "20230604110420****100232280022D31",
"Action": "DescribeDirectConnectConnectionAttributes",
"Version": "2020-04-01",
"Service": "directconnect",
"Region": "cn-north-1"
},
"Result": {
"AccountId": "21000*****",
"AdvanceFeatures": [
{
"macsec": true
}
],
"Bandwidth": 1000,
"BillingType": 1,
"BusinessStatus": "Normal",
"ConnectionType": "DedicatedConnection",
"CreationTime": "2021-04-09T08:36:47+08:00",
"CustomerContactEmail": "exampletest@163.com",
"CustomerContactPhone": "185****2333",
"CustomerName": "韩*梅",
"DeletedTime": "2023-12-02 23:59:59",
"Description": "This is a sample description",
"DirectConnectAccessPointId": "ap-cn-shanghai-***-A",
"DirectConnectConnectionId": "dcc-7qthudw0ll6jmc****",
"DirectConnectConnectionName": "test",
"DirectConnectTrafficQosPolicyId": "dcq-4atoi32cl4c9t0q****",
"ExpectBandwidth": 500,
"ExpectedExpireShutdownTime": "2024-10-11 12:00:00",
"ExpiredTime": "2023-12-03 12:00:00",
"IsCloudLinkService": true,
"LineNumber": "N9234***",
"LineOperator": "ChinaTelecom",
"MacsecCipherSuite": "GCM-AES-XPN-256",
"MacsecEncryptionMode": "no_encrypt",
"MacsecKeys": [
{
"Status": "Available",
"KeyName": "macsec-key-1",
"StartOn": "2026-04-13T19:40:53+08:00"
}
],
"ParentConnectionAccountId": "2000956****",
"ParentConnectionId": "dcc-e5z1z57glr0g2yjrzamyw****",
"PeerLocation": "北京IDC",
"PortSpec": "1G",
"PortType": "1000Base",
"ProjectName": "Project_1",
"Status": "Available",
"Tags": [
{
"Key": "k1",
"Value": "v1"
}
],
"UpdateTime": "2021-04-10T09:18:28+08:00",
"VlanId": 1212
}
}
Error codes
The following table lists the error codes related to the business logic for this API. For details, see Common error codes.
Status code | Error codes | Error message | Description |
404 | InvalidDirectConnectConnection.NotFound | The specified direct connect connection does not exist. | The specified DC Connection does not exist. |
Last updated: 2026.07.28 15:07:22
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
