Help Center/ Direct Connect/ API Reference/ API/ Global DC Gateways/ Creating a Global DC Gateway

Updated on 2025-10-28 GMT+08:00

View PDF

Creating a Global DC Gateway

Function

This API is used to create a global DC gateway that can be attached to an enterprise router.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/dcaas/global-dc-gateways

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID. Minimum: 0 Maximum: 36

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header. Minimum: 0 Maximum: 10240

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
global_dc_gateway	Yes	CreateGlobalDcGateway object	Specifies the global DC gateway to be created.

**Table 4** CreateGlobalDcGateway
Parameter	Mandatory	Type	Description
tenant_id	No	String	Specifies the tenant ID. Minimum: 0 Maximum: 255
name	Yes	String	Specifies the name of the global DC gateway. Minimum: 0 Maximum: 64
description	No	String	Provides supplementary information about the global DC gateway. Minimum: 0 Maximum: 255
bgp_asn	No	Long	Specifies the ASN assigned to the global DC gateway. Minimum: 1 Maximum: 4294967295
enterprise_project_id	No	String	Specifies the ID of the enterprise project that the global DC gateway belongs to. Default: 0 Minimum: 0 Maximum: 36
address_family	No	String	Specifies the IP address family of the global DC gateway. ipv4: Only IPv4 is supported. dual: Both IPv4 and IPv6 are supported.
tags	No	Array of Tag objects	Specifies the tag added to the global DC gateway. Array Length: 0 - 10

**Table 5** Tag
Parameter	Mandatory	Type	Description
key	Yes	String	Specifies the tag key. The key can contain a maximum of 36 Unicode characters, including letters, digits, hyphens (-), and underscores (_). Minimum: 0 Maximum: 36
value	No	String	Specifies the tag value. The value can contain a maximum of 43 Unicode characters, including letters, digits, hyphens (-), underscores (_), and periods (.). Minimum: 0 Maximum: 43

Response Parameters

Status code: 201

**Table 6** Response body parameters
Parameter	Type	Description
global_dc_gateway	CreateGlobalDcGatewayEntry object	Specifies the global DC gateway.
request_id	String	Specifies the request ID. Minimum: 0 Maximum: 36

**Table 7** CreateGlobalDcGatewayEntry
Parameter	Type	Description
id	String	Specifies the global DC gateway ID. Minimum: 0 Maximum: 36
tenant_id	String	Specifies the project ID. Minimum: 0 Maximum: 255
name	String	Specifies the name of the global DC gateway. Minimum: 0 Maximum: 64
description	String	Provides supplementary information about the global DC gateway. Minimum: 0 Maximum: 128
enterprise_project_id	String	Specifies the ID of the enterprise project that the global DC gateway belongs to. Minimum: 0 Maximum: 36
global_center_network_id	String	Specifies the ID of the central network that the global DC gateway is added to. Minimum: 0 Maximum: 36
bgp_asn	Long	Specifies the BGP ASN of the global DC gateway. Minimum: 0 Maximum: 65535
region_id	String	Specifies the region of the global DC gateway. Minimum: 0 Maximum: 36
location_name	String	Specifies the location of the global DC gateway. Minimum: 0 Maximum: 36
current_peer_link_count	Integer	Specifies the number of peer links allowed on a global DC gateway, indicating the number of enterprise routers that the global DC gateway can be attached to.
available_peer_link_count	Integer	Specifies the number of peer links that can be created for a global DC gateway.
tags	Array of Tag objects	Specifies the tag added to the global DC gateway. Array Length: 0 - 10
admin_state_up	Boolean	Specifies the administrative status of the global DC gateway. true: The global DC gateway is available. false: The global DC gateway is frozen.
status	String	Specifies the status of the global DC gateway.- DOWN: The global DC gateway is faulty.- PENDING_UPDATE: The global DC gateway is being updated.- ACTIVE: The global DC gateway is available.- ERROR: An error occurred.
created_time	String	Specifies the time when the global DC gateway was created.
address_family	String	Specifies the IP address family of the global DC gateway. ipv4: Only IPv4 is supported. dual: Both IPv4 and IPv6 are supported.

**Table 8** Tag
Parameter	Type	Description
key	String	Specifies the tag key. The key can contain a maximum of 36 Unicode characters, including letters, digits, hyphens (-), and underscores (_). Minimum: 0 Maximum: 36
value	String	Specifies the tag value. The value can contain a maximum of 43 Unicode characters, including letters, digits, hyphens (-), underscores (_), and periods (.). Minimum: 0 Maximum: 43

Example Requests

Creating a global DC gateway

POST https://{dc_endpoint}/v3/b197c48159d44a66b32c538c3f8da89a/dcaas/global-dc-gateways

{
  "global_dc_gateway" : {
    "bgp_asn" : "64512",
    "description" : "",
    "enterprise_project_id" : "0",
    "name" : "dgw-2c18",
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    } ],
    "address_family" : "ipv4"
  }
}

Example Responses

Status code: 201

Created

Global DC gateway that has been created

{
  "request_id" : "2e97ccd07037d0f48abc620979b65976",
  "global_dc_gateway" : {
    "enterprise_project_id" : "0",
    "name" : "dgw-2c18",
    "id" : "71f6ac9b-2745-4fb8-96c8-9d97d969c4b5",
    "tenant_id" : "b197c48159d44a66b32c538c3f8da89a",
    "description" : "",
    "status" : "DOWN",
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    } ],
    "admin_state_up" : true,
    "created_time" : "2024-12-11T23:33:19.000Z",
    "bgp_asn" : 64512,
    "global_center_network_id" : null,
    "current_peer_link_count" : null,
    "available_peer_link_count" : 3,
    "location_name" : null,
    "region_id" : null,
    "address_family" : "ipv4"
  }
}