Help Center/ Cloud Connect/ API Reference/ API/ Central Network Attachments/ Adding a Global DC Gateway to a Central Network

Updated on 2024-05-13 GMT+08:00

Online Debugging

CLI Examples

View PDF

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. Minimum: 10 Maximum: 32
central_network_id	Yes	String	Central network ID. Minimum: 36 Maximum: 36

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. Minimum: 0 Maximum: 2000000

**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	Resource name.
description	No	String	Resource description. Angle brackets (<>) are not allowed. Minimum: 0 Maximum: 255
enterprise_router_id	Yes	String	Enterprise router ID.
global_dc_gateway_id	Yes	String	Resource ID.
enterprise_router_project_id	Yes	String	Project ID of the enterprise router.
enterprise_router_region_id	Yes	String	Region ID of the enterprise router.
global_dc_gateway_project_id	Yes	String	Project ID.
global_dc_gateway_region_id	Yes	String	Region ID.
central_network_plane_id	No	String	Resource ID.

Response Parameters

Status code: 202

**Table 5** Response body parameters
Parameter	Type	Description
request_id	String	Resource ID. Minimum: 32 Maximum: 36
central_network_gdgw_attachment	CentralNetworkGdgwAttachment object	Details of the global DC gateway used as an attachment.

**Table 6** CentralNetworkGdgwAttachment
Parameter	Type	Description
id	String	Resource ID.
name	String	Resource name.
description	String	Resource description. Angle brackets (<>) are not allowed. Minimum: 0 Maximum: 255
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 private bandwidth billed by fixed bandwidth is required, and cross-site connection bandwidths are assigned from the global private bandwidth. TestBandwidth: The test bandwidth is free. Only the minimum bandwidth is used for testing cross-region connectivity.
bandwidth_size	Integer	Bandwidth range, 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 the enterprise router.
enterprise_router_attachment_id	String	Attachment ID of the enterprise router.
global_dc_gateway_peer_link_id	String	Resource ID.
global_dc_gateway_id	String	Resource ID.
global_dc_gateway_project_id	String	Project ID.
global_dc_gateway_region_id	String	Region ID.
enterprise_router_site_code	String	Site code definition.
global_dc_gateway_site_code	String	Site code definition.

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" : "cn-north-4",
    "global_dc_gateway_project_id" : "32f7402e18154ce5861c9989df956394",
    "global_dc_gateway_region_id" : "cn-north-4",
    "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" : "cn-north-4",
    "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" : "cn-north-4",
    "enterprise_router_site_code" : "cn-north-bj4",
    "global_dc_gateway_site_code" : "cn-north-bj4"
  }
}