Direct Connect
Direct Connect
Document
- Documentation
Direct ConnectAPI ReferenceDC GatewayCreateDirectConnectGateway - Creating a DC Gateway
Copy page
Download PDFDC Gateway
CreateDirectConnectGateway - Creating a DC Gateway
Copy pageDownload PDFCreateDirectConnectGateway - Creating a DC Gateway
Call CreateDirectConnectGateway to create a Direct Connect (DC) Gateway.
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: CreateDirectConnectGateway
The interface name. The current API name is CreateDirectConnectGateway.
Version String required Example: 2020-04-01
The interface version. The current API version is 2020-04-01.
DirectConnectGatewayName String required Example: test
Name of the DC Gateway.
- Must start with a Chinese character, letter, or number. May include Chinese characters, letters, numbers, periods (.), underscores (_), and hyphens (-).
- Must be 1 to 128 characters.
- If you do not provide this parameter or leave it unset, it defaults to the ID of the DC Gateway.
Description String optional Example: This is a sample description
Description of the DC Gateway.
- Must start with a Chinese character, letter, or number. May include Chinese characters, letters, numbers, periods (.), spaces ( ), underscores (_), hyphens (-), equals signs (=), commas (,), Chinese commas (，), and Chinese periods (。).
- Must be 0 to 255 characters.
- If you do not provide this parameter or leave it unset, it defaults to an empty string.
ClientToken String optional Example: 123e4567-e89b-12d3-a456-42665544****
Client Token that is used to ensure the request idempotency.
- You can use the client to automatically generate a token, but must confirm that the tokens for different requests are unique. This prevents repeated actions due to multiple client retries when the call of the API action times out or an internal server error occurs.
- Must not exceed 64 ASCII characters.
- If you do not provide ClientToken, this API call does not verify idempotency.
EnableIpv6 Boolean optional Example: false
Specify whether to enable IPv6. Type the enumerated values strictly in the case form as follows. Do not set other values.
- true: Enable
- false: Disable.
Tags.N.Key String optional Example: key1
Tag key (Key) of the DC Gateway.
- N represents the sequence number of a tag key. It must be set in consecutive, ascending order starting from 1 up to 50.
- Separate multiple tag keys with ampersands (&).
- Must not start with volc: or sys: in any case form. volc: and sys: prefixes are reserved for system tags. You cannot create tags starting with these prefixes.
- Must be 1 to 128 characters. May include characters in different languages, numbers, spaces ( ), underscores (_), periods (.), half-width colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and at signs (@).
Tags.N.Value String optional Example: value1
Tag value (Value) of the DC Gateway.
- N represents the sequence number of a tag value. It must be set in consecutive, ascending order starting from 1 up to 50.
- Separate multiple tag values with ampersands (&).
- Must be 0 to 256 characters in length. If left blank, this parameter defaults to an empty string.
- May include characters in different languages, numbers, spaces ( ), underscores (_), periods (.), half-width colons (:), slashes (/), equal signs (=), plus signs (+), hyphens (-), and at signs (@).
- It is case-sensitive. Cannot start or end with a space.
tip
To provide Tags.N.Value, you must provide Tags.N.Key.
BgpAsn Integer optional Example: 137718
ASN (Autonomous System Number) of the DC Gateway.
- The valid range for DC Gateway ASN is 137718, 64512-65534, and 4200000000-4294967294, among which 137718 is the ASN of VolcanoEngine.
- If a DC Gateway is used only in a common scenario (such as an on-premises data center connecting to a single Virtual Private Cloud resource via DC), use the VolcanoEngine ASN (137718).
- If a DC Gateway is used in a special scenario (such as an on-premises data center connecting to multiple CENs via DC), you need to customize an ASN to each DC Gateway and avoid using the VolcanoEngine ASN (137718) to ensure no duplicate ASNs among different DC Gateways.
Response parameters
The following only details response parameters specific to this API. For more information, see Response structure.
DirectConnectGatewayId String Example: dcg-7qthudw0ll6jmc****
ID of the newly created DC Gateway.
Request examples
GET /?Action=CreateDirectConnectGateway&Version=2020-04-01&DirectConnectGatewayName=test&Description=This is a sample description&ClientToken=123e4567-e89b-12d3-a456-42665544****&EnableIpv6=false&Tags.1.Key=key1&Tags.1.Value=value1&BgpAsn=137718 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 examples
{
"ResponseMetadata": {
"RequestId": "202111161611080102121461940900****",
"Action": "CreateDirectConnectGateway",
"Version": "2020-04-01",
"Service": "directconnect",
"Region": "cn-beijing"
},
"Result": {
"RequestId": "202111161611080102121461940900****",
"DirectConnectGatewayId": "dcg-7qthudw0ll6jmc****"
}
}
Error codes
The table below describes the error codes for this API that are associated with business logic. For details, see Common error codes.
Last updated: 2026.02.26 11:13:16
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
