Help Center/ Direct Connect/ API Reference/ API/ Global DC Gateways/ Creating a Global DC Gateway
Updated on 2026-11-11 GMT+08:00

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.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    dcaas:gdgw:create

    Write

    gdgw *

    -

    -

    -

    -

    • g:EnterpriseProjectId

    • g:RequestTag/<tag-key>

    • g:TagKeys

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Specifies the project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. After the request is processed, the value of X-Subject-Token in the header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

global_dc_gateway

Yes

CreateGlobalDcGateway object

Definition

Specifies the details for creating a global DC gateway.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 4 CreateGlobalDcGateway

Parameter

Mandatory

Type

Description

tenant_id

No

String

Definition

Specifies the project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

name

Yes

String

Definition

Specifies the name of the global DC gateway.

Constraints

N/A

Range

The value can contain 1 to 64 characters, including only letters (a–z or A–Z), digits (0 to 9), underscores (_), periods (.), and hyphens (-).

Default Value

N/A

description

No

String

Definition

Specifies the description.

Constraints

N/A

Range

The value can contain a maximum of 255 characters. Angle brackets (< and >) are not allowed.

Default Value

N/A

bgp_asn

No

Long

Definition

Specifies the ASN assigned to the global DC gateway.

Constraints

N/A

Range

1 to 4294967295

Default Value

N/A

enterprise_project_id

No

String

Definition

Specifies the ID of the enterprise project that the global DC gateway belongs to.

Constraints

N/A

Range

The value can contain a maximum of 36 characters.

Default Value

0

address_family

No

String

Definition

Specifies the address family of the global DC gateway.

  • ipv4

  • dual

Constraints

N/A

Range

  • ipv4

  • dual

Default Value

N/A

tags

No

Array of Tag objects

Definition

Specifies the tags added to the global DC gateway.

Constraints

The array length ranges from 0 to 10.

Table 5 Tag

Parameter

Mandatory

Type

Description

key

Yes

String

Definition

Specifies the tag key. Each key cannot start or end with a space, or start with _sys_. Only letters, digits, spaces, and the following special characters are allowed: _.:=+-@

Constraints

N/A

Range

1 to 128 characters

Default Value

N/A

value

No

String

Definition

Specifies the tag value. The value can contain letters, digits, spaces, and the following special characters: _.:/=+-@

Constraints

N/A

Range

The value can contain a maximum of 255 characters.

Default Value

N/A

Response Parameters

Status code: 201

Table 6 Response body parameters

Parameter

Type

Description

global_dc_gateway

CreateGlobalDcGatewayEntry object

Definition

Specifies the global DC gateway details.

Range

N/A

request_id

String

Definition

Specifies the request ID.

Range

The value can contain a maximum of 36 characters.

Table 7 CreateGlobalDcGatewayEntry

Parameter

Type

Description

id

String

Definition

Specifies the global DC gateway ID.

Range

The value can contain a maximum of 36 characters.

tenant_id

String

Definition

Specifies the project ID.

Range

N/A

name

String

Definition

Specifies the name of the global DC gateway.

Range

The value can contain a maximum of 64 characters.

description

String

Definition

Specifies the description.

Range

The value can contain a maximum of 128 characters.

enterprise_project_id

String

Definition

Specifies the ID of the enterprise project that the global DC gateway belongs to.

Range

The value can contain a maximum of 36 characters.

global_center_network_id

String

Definition

Specifies the ID of the central network that the global DC gateway is added to.

Range

The value can contain a maximum of 36 characters.

bgp_asn

Long

Definition

Specifies the BGP ASN of the global DC gateway.

Range

0 to 65535

region_id

String

Definition

Specifies the region of the global DC gateway.

Range

N/A

location_name

String

Definition

Specifies the location of the global DC gateway.

Range

The value can contain a maximum of 36 characters.

current_peer_link_count

Integer

Definition

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.

Range

N/A

available_peer_link_count

Integer

Definition

Specifies the number of peer links that can be created for a global DC gateway.

Range

N/A

tags

Array of Tag objects

Definition

Specifies the tags added to the global DC gateway.

admin_state_up

Boolean

Definition

Specifies the administrative status of the global DC gateway. true indicates that the global DC gateway is available, and false indicates that the global DC gateway is frozen.

Range

  • true

  • false

status

String

Definition

Specifies the status of the global DC gateway. The value can be DOWN (the global DC gateway becomes faulty), PENDING_UPDATE (the global DC gateway is being updated), ACTIVE (the global DC gateway is available), or ERROR (an error occurred).

Range

  • DOWN

  • PENDING_UPDATE

  • ACTIVE

  • ERROR

created_time

String

Definition

Specifies the creation time.

address_family

String

Definition

Specifies the address family of the global DC gateway.

  • ipv4

  • dual

Range

  • ipv4

  • dual

Table 8 Tag

Parameter

Type

Description

key

String

Definition

Specifies the tag key. Each key cannot start or end with a space, or start with _sys_. Only letters, digits, spaces, and the following special characters are allowed: _.:=+-@

Range

1 to 128 characters

value

String

Definition

Specifies the tag value. The value can contain letters, digits, spaces, and the following special characters: _.:/=+-@

Range

The value can contain a maximum of 255 characters.

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

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"
  }
}

SDK Sample Code

The SDK sample code is as follows.

Creating a global DC gateway

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dc.v3.region.DcRegion;
import com.huaweicloud.sdk.dc.v3.*;
import com.huaweicloud.sdk.dc.v3.model.*;

import java.util.List;
import java.util.ArrayList;

public class CreateGlobalDcGatewaySolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        DcClient client = DcClient.newBuilder()
                .withCredential(auth)
                .withRegion(DcRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateGlobalDcGatewayRequest request = new CreateGlobalDcGatewayRequest();
        CreateGlobalDcGatewayRequestBody body = new CreateGlobalDcGatewayRequestBody();
        List<Tag> listGlobalDcGatewayTags = new ArrayList<>();
        listGlobalDcGatewayTags.add(
            new Tag()
                .withKey("key1")
                .withValue("value1")
        );
        CreateGlobalDcGateway globalDcGatewaybody = new CreateGlobalDcGateway();
        globalDcGatewaybody.withName("dgw-2c18")
            .withDescription("")
            .withBgpAsn(64512L)
            .withEnterpriseProjectId("0")
            .withAddressFamily(CreateGlobalDcGateway.AddressFamilyEnum.fromValue("ipv4"))
            .withTags(listGlobalDcGatewayTags);
        body.withGlobalDcGateway(globalDcGatewaybody);
        request.withBody(body);
        try {
            CreateGlobalDcGatewayResponse response = client.createGlobalDcGateway(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Creating a global DC gateway

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdc.v3.region.dc_region import DcRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdc.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = DcClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DcRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateGlobalDcGatewayRequest()
        listTagsGlobalDcGateway = [
            Tag(
                key="key1",
                value="value1"
            )
        ]
        globalDcGatewaybody = CreateGlobalDcGateway(
            name="dgw-2c18",
            description="",
            bgp_asn=64512,
            enterprise_project_id="0",
            address_family="ipv4",
            tags=listTagsGlobalDcGateway
        )
        request.body = CreateGlobalDcGatewayRequestBody(
            global_dc_gateway=globalDcGatewaybody
        )
        response = client.create_global_dc_gateway(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Creating a global DC gateway

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := dc.DcClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := dc.NewDcClient(hcClient)

    request := &model.CreateGlobalDcGatewayRequest{}
	valueTags:= "value1"
	var listTagsGlobalDcGateway = []model.Tag{
        {
            Key: "key1",
            Value: &valueTags,
        },
    }
	descriptionGlobalDcGateway:= ""
	bgpAsnGlobalDcGateway:= int64(64512)
	enterpriseProjectIdGlobalDcGateway:= "0"
	addressFamilyGlobalDcGateway:= model.GetCreateGlobalDcGatewayAddressFamilyEnum().IPV4
	globalDcGatewaybody := &model.CreateGlobalDcGateway{
		Name: "dgw-2c18",
		Description: &descriptionGlobalDcGateway,
		BgpAsn: &bgpAsnGlobalDcGateway,
		EnterpriseProjectId: &enterpriseProjectIdGlobalDcGateway,
		AddressFamily: &addressFamilyGlobalDcGateway,
		Tags: &listTagsGlobalDcGateway,
	}
	request.Body = &model.CreateGlobalDcGatewayRequestBody{
		GlobalDcGateway: globalDcGatewaybody,
	}
	response, err := client.CreateGlobalDcGateway(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

201

Created

Error Codes

See Error Codes.