Help Center/ Cloud Connect/ API Reference/ API/ Central Network Attachments/ Adding a Global DC Gateway to a Central Network
Updated on 2024-11-19 GMT+08:00

Adding a Global DC Gateway to a Central Network

Function

This API is used to add a global DC gateway to a central network as an attachment.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{domain_id}/gcn/central-network/{central_network_id}/gdgw-attachments

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Account ID.

central_network_id

Yes

String

Central network ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

central_network_gdgw_attachment

Yes

CreateCentralNetworkGdgwAttachment object

Request body for adding a global DC gateway to a central network as an attachment.

Table 4 CreateCentralNetworkGdgwAttachment

Parameter

Mandatory

Type

Description

name

Yes

String

Instance name.

description

No

String

Resource description. Angle brackets (<>) are not allowed.

enterprise_router_id

Yes

String

Enterprise router ID.

global_dc_gateway_id

Yes

String

Global DC gateway ID.

global_dc_gateway_project_id

Yes

String

Project ID of the global DC gateway.

global_dc_gateway_region_id

Yes

String

Region ID of the global DC gateway.

enterprise_router_project_id

Yes

String

Project ID of the enterprise router.

enterprise_router_region_id

Yes

String

Region ID of an enterprise router.

central_network_plane_id

No

String

ID of the central network plane.

Response Parameters

Status code: 202

Table 5 Response body parameters

Parameter

Type

Description

request_id

String

Request ID.

central_network_gdgw_attachment

CentralNetworkGdgwAttachment object

Details of the global DC gateway used as an attachment.

Table 6 CentralNetworkGdgwAttachment

Parameter

Type

Description

id

String

Instance ID.

name

String

Instance name.

description

String

Resource description. Angle brackets (<>) are not allowed.

domain_id

String

ID of the account that the instance belongs to.

state

String

Central network connection status.

  • AVAILABLE: The connection is available.

  • CREATING: The connection is being created.

  • UPDATING: The connection is being updated.

  • DELETING: The connection is being deleted.

  • FREEZING: The connection is being frozen.

  • UNFREEZING: The connection is being unfrozen.

  • RECOVERING: The connection is being recovered.

  • FAILED: The operation on the connection failed.

  • DELETED: The connection is deleted.

  • APPROVING: The connection is being approved.

  • APPROVED: The connection is approved.

  • UNAPPROVED: The approval failed.

created_at

String

Time when the resource was created. The time is in the yyyy-MM-ddTHH:mm:ss format.

updated_at

String

Time when the resource was updated. The time must be in the yyyy-MM-ddTHH:mm:ss format.

central_network_id

String

Central network ID.

central_network_plane_id

String

ID of the central network plane.

global_connection_bandwidth_id

String

Global connection bandwidth ID.

bandwidth_type

String

Bandwidth type. The bandwidth types are as follows:

  • BandwidthPackage: A global connection bandwidth billed by fixed bandwidth is required, and cross-site connection bandwidths are assigned from the global connection bandwidth.

  • TestBandwidth: The test bandwidth is free. Only the minimum bandwidth is used for testing cross-region connectivity.

bandwidth_size

Integer

Amount of bandwidth, in Mbit/s.

is_frozen

Boolean

Whether the resource is frozen.

enterprise_router_id

String

Enterprise router ID.

enterprise_router_project_id

String

Project ID of the enterprise router.

enterprise_router_region_id

String

Region ID of an enterprise router.

enterprise_router_attachment_id

String

Attachment ID of the enterprise router.

global_dc_gateway_peer_link_id

String

Peer link ID of the global DC gateway.

global_dc_gateway_id

String

Global DC gateway ID.

global_dc_gateway_project_id

String

Project ID of the global DC gateway.

global_dc_gateway_region_id

String

Region ID of the global DC gateway.

enterprise_router_site_code

String

Site code of the enterprise router on a central network.

global_dc_gateway_site_code

String

Site code.

Example Requests

Adding a global DC gateway to a central network

POST /v3/{domain_id}/gcn/central-network/{central_network_id}/gdgw-attachments

{
  "central_network_gdgw_attachment" : {
    "name" : "name",
    "description" : "description",
    "enterprise_router_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "global_dc_gateway_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "enterprise_router_project_id" : "32f7402e18154ce5861c9989df956394",
    "enterprise_router_region_id" : "region-abc",
    "global_dc_gateway_project_id" : "32f7402e18154ce5861c9989df956394",
    "global_dc_gateway_region_id" : "region-abc",
    "central_network_plane_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b"
  }
}

Example Responses

Status code: 202

The global DC gateway has been added as an attachment on the central network.

{
  "request_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
  "central_network_gdgw_attachment" : {
    "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "name" : "name",
    "description" : "description",
    "domain_id" : "XXX",
    "state" : "AVAILABLE",
    "created_at" : "2023-10-09T10:09:28.908Z",
    "updated_at" : "2023-10-09T10:09:28.908Z",
    "central_network_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "central_network_plane_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "global_connection_bandwidth_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "bandwidth_type" : "BandwidthPackage",
    "bandwidth_size" : 20,
    "is_frozen" : false,
    "enterprise_router_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "enterprise_router_project_id" : "XXX",
    "enterprise_router_region_id" : "region-abc",
    "enterprise_router_attachment_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "global_dc_gateway_peer_link_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "global_dc_gateway_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "global_dc_gateway_project_id" : "XXX",
    "global_dc_gateway_region_id" : "region-abc",
    "enterprise_router_site_code" : "site-abc",
    "global_dc_gateway_site_code" : "site-abc"
  }
}

SDK Sample Code

The SDK sample code is as follows.

Adding a global DC gateway to a central network

 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
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
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.cc.v3.region.CcRegion;
import com.huaweicloud.sdk.cc.v3.*;
import com.huaweicloud.sdk.cc.v3.model.*;


public class CreateCentralNetworkGdgwAttachmentSolution {

    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");

        ICredential auth = new GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        CcClient client = CcClient.newBuilder()
                .withCredential(auth)
                .withRegion(CcRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateCentralNetworkGdgwAttachmentRequest request = new CreateCentralNetworkGdgwAttachmentRequest();
        request.withCentralNetworkId("{central_network_id}");
        CreateCentralNetworkGdgwAttachmentRequestBody body = new CreateCentralNetworkGdgwAttachmentRequestBody();
        CreateCentralNetworkGdgwAttachment centralNetworkGdgwAttachmentbody = new CreateCentralNetworkGdgwAttachment();
        centralNetworkGdgwAttachmentbody.withGlobalDcGatewayRegionId("region-abc")
            .withCentralNetworkPlaneId("a3bad420-33b8-4e26-9e9b-bdf67aa8e72b")
            .withEnterpriseRouterId("a3bad420-33b8-4e26-9e9b-bdf67aa8e72b")
            .withEnterpriseRouterProjectId("32f7402e18154ce5861c9989df956394")
            .withName("name")
            .withGlobalDcGatewayId("a3bad420-33b8-4e26-9e9b-bdf67aa8e72b")
            .withEnterpriseRouterRegionId("region-abc")
            .withDescription("description")
            .withGlobalDcGatewayProjectId("32f7402e18154ce5861c9989df956394");
        body.withCentralNetworkGdgwAttachment(centralNetworkGdgwAttachmentbody);
        request.withBody(body);
        try {
            CreateCentralNetworkGdgwAttachmentResponse response = client.createCentralNetworkGdgwAttachment(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());
        }
    }
}

Adding a global DC gateway to a central network

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdkcc.v3.region.cc_region import CcRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcc.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"]

    credentials = GlobalCredentials(ak, sk)

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

    try:
        request = CreateCentralNetworkGdgwAttachmentRequest()
        request.central_network_id = "{central_network_id}"
        centralNetworkGdgwAttachmentbody = CreateCentralNetworkGdgwAttachment(
            global_dc_gateway_region_id="region-abc",
            central_network_plane_id="a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
            enterprise_router_id="a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
            enterprise_router_project_id="32f7402e18154ce5861c9989df956394",
            name="name",
            global_dc_gateway_id="a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
            enterprise_router_region_id="region-abc",
            description="description",
            global_dc_gateway_project_id="32f7402e18154ce5861c9989df956394"
        )
        request.body = CreateCentralNetworkGdgwAttachmentRequestBody(
            central_network_gdgw_attachment=centralNetworkGdgwAttachmentbody
        )
        response = client.create_central_network_gdgw_attachment(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Adding a global DC gateway to a central network

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    cc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/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")

    auth := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := cc.NewCcClient(
        cc.CcClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateCentralNetworkGdgwAttachmentRequest{}
	request.CentralNetworkId = "{central_network_id}"
	centralNetworkPlaneIdCentralNetworkGdgwAttachment:= "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b"
	descriptionCentralNetworkGdgwAttachment:= "description"
	centralNetworkGdgwAttachmentbody := &model.CreateCentralNetworkGdgwAttachment{
		GlobalDcGatewayRegionId: "region-abc",
		CentralNetworkPlaneId: &centralNetworkPlaneIdCentralNetworkGdgwAttachment,
		EnterpriseRouterId: "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
		EnterpriseRouterProjectId: "32f7402e18154ce5861c9989df956394",
		Name: "name",
		GlobalDcGatewayId: "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
		EnterpriseRouterRegionId: "region-abc",
		Description: &descriptionCentralNetworkGdgwAttachment,
		GlobalDcGatewayProjectId: "32f7402e18154ce5861c9989df956394",
	}
	request.Body = &model.CreateCentralNetworkGdgwAttachmentRequestBody{
		CentralNetworkGdgwAttachment: centralNetworkGdgwAttachmentbody,
	}
	response, err := client.CreateCentralNetworkGdgwAttachment(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

202

The global DC gateway has been added as an attachment on the central network.

Error Codes

See Error Codes.