Direct Connect
Direct Connect
Document
- Documentation
Direct ConnectAPI ReferenceDC Virtual InterfaceDescribeDirectConnectVirtualInterfaceAttributes - Querying details of a Virtual Interface
Copy page
Download PDFDC Virtual Interface
DescribeDirectConnectVirtualInterfaceAttributes - Querying details of a Virtual Interface
Copy pageDownload PDFDescribeDirectConnectVirtualInterfaceAttributes - Querying details of a Virtual Interface
Call DescribeDirectConnectVirtualInterfaceAttributes to query the details of a specified Virtual Interface.
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: DescribeDirectConnectVirtualInterfaceAttributes
The interface name. The current API name is DescribeDirectConnectVirtualInterfaceAttributes.
Version String required Example: 2020-04-01
The interface version. The current API version is 2020-04-01.
VirtualInterfaceId String required Example: dcv-7qthudw0ll6jmc****
The ID of the Virtual Interface to be queried. You can call DescribeDirectConnectVirtualInterfaces to query the ID of the Virtual Interface.
Response parameters
Only the response parameters specific to this API are listed below. For more information, see Response structure.
AccountId String Example: 21000*****
The ID of the current VolcanoEngine account.
VirtualInterfaceId String Example: dcv-7qthudw0ll6jmc****
The ID of the Virtual Interface.
VirtualInterfaceName String Example: test
The name of the Virtual Interface.
Description String Example: This is a sample description
The description of the Virtual Interface.
DirectConnectConnectionId String Example: dcc-3tehy13n2l4c6c0v****
The ID of the DC Connection associated with the Virtual Interface.
DirectConnectGatewayId String Example: dcg-2fe3zsmkshs59g****
The ID of the DC Gateway associated with the Virtual Interface.
RouteType String Example: BGP
The route type of the Virtual Interface.
VlanId Integer Example: 2000
The VLAN ID of the Virtual Interface.
LocalIp String Example: 192.XX.XX.10/24
Cloud gateway peer IP of the Virtual Interface.
PeerIp String Example: 192.XX.XX.20/24
Your gateway peer IP of the Virtual Interface
CreationTime String Example: 2021-04-09T08:36:47+08:00
The time when the Virtual Interface is created.
UpdateTime String Example: 2021-04-10T09:18:28+08:00
The time when the Virtual Interface is updated.
Status String Example: Available
The status of the Virtual Interface.
- Creating
- Deleting
- Pending: Configuration in progress.
- Available
BfdDetectInterval Integer Example: 1000
The time interval for detection. Unit: ms.
BfdDetectMultiplier Integer Example: 3
The number of Bidirectional Forwarding Detection (BFD) attempts.
Bandwidth Integer Example: 100
Limited bandwidth of the Virtual Interface. Unit: Mbps.
Tags Object[] Example: -
The information about all tags added to the Virtual Interface.
Key String Example: k1
The tag key.
Value String Example: v1
The tag value.
EnableNqa Boolean Example: false
Describe whether the NQA is enabled.
- true: Enabled
- false: Not enabled
NqaDetectInterval Integer Example: 3000
The time interval for Network Quality Analyzer (NQA) to send consecutive packets.
NqaDetectMultiplier Integer Example: 8
The number of NQA detection attempts. If consecutive failure count reaches the set value for the detect multiplier, the system declares a faulty line.
LocalIpv6Ip String Example: fe80:XX::1/120
The IPv6 address of Cloud gateway peer IP for the Virtual Interface.
PeerIpv6Ip String Example: fe80:XX::2/120
The IPv6 address of Your gateway peer IP for the Virtual Interface.
OwnerAccountId String Example: 21000522****
The VolcanoEngine account to which the Virtual Interface belongs.
EnableBfd Boolean Example: false
Describe whether BFD is enabled.
- true: Enabled
- false: Not enabled
EnableBfdEcho Boolean Example: false
Describes whether BFD echo packet is enabled.
- true: Enabled
- false: Not enabled
DirectExchangeGatewayId String Example: dxg-273w1ti8gr***
The ID of the DXGW associated with the Virtual Interface
DxgwOwnerId String Example: 2108892****
The account that owns the DXGW resource.
DxgwStatus String Example: Available
The status of the DXGW.
- Creating
- Deleting
- Pending: Configuration in progress.
- Available
GatewayType String Example: DCGW
The gateway type associated with the Virtual Interface.
- DCGW: Direct Connect Gateway
- DXGW: Global Direct Exchange Gateway
Request example
GET /?Action=DescribeDirectConnectVirtualInterfaceAttributes&Version=2020-04-01&VirtualInterfaceId=dcv-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": "DescribeDirectConnectVirtualInterfaceAttributes",
"Version": "2020-04-01",
"Service": "directconnect",
"Region": "cn-north-1"
},
"Result": {
"AccountId": "21000*****",
"Bandwidth": 100,
"BfdDetectInterval": 1000,
"BfdDetectMultiplier": 3,
"CreationTime": "2021-04-09T08:36:47+08:00",
"Description": "This is a sample description",
"DirectConnectConnectionId": "dcc-3tehy13n2l4c6c0v****",
"DirectConnectGatewayId": "dcg-2fe3zsmkshs59g****",
"DirectExchangeGatewayId": "dxg-273w1ti8grfnk7fap8tnkmfp9",
"DxgwOwnerId": "2108892****",
"DxgwStatus": "Available",
"EnableBfd": false,
"EnableBfdEcho": false,
"EnableNqa": true,
"GatewayType": "DCGW",
"LocalIp": "192.XX.XX.10/24",
"LocalIpv6Ip": "fe80:XX::1/120",
"NqaDetectInterval": 3000,
"NqaDetectMultiplier": 8,
"OwnerAccountId": "21000522****",
"PeerIp": "192.XX.XX.20/24",
"PeerIpv6Ip": "fe80:XX::2/120",
"RouteType": "BGP",
"Status": "Available",
"Tags": [
{
"Key": "k1",
"Value": "v1"
}
],
"UpdateTime": "2021-04-10T09:18:28+08:00",
"VirtualInterfaceId": "dcv-7qthudw0ll6jmc****",
"VirtualInterfaceName": "test",
"VlanId": 2000
}
}
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 | InvalidDirectConnectVirtualInterface.NotFound | The specified direct connect virtual interface does not exist. | The specified Virtual Interface does not exist. |
Last updated: 2026.07.28 15:07:23
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
