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.
URI
POST /v3/{domain_id}/gcn/central-network/{central_network_id}/gdgw-attachments
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Account ID. |
central_network_id |
Yes |
String |
Central network ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
User token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
central_network_gdgw_attachment |
Yes |
Request body for adding a global DC gateway to a central network as an attachment. |
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
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Request ID. |
central_network_gdgw_attachment |
CentralNetworkGdgwAttachment object |
Details of the global DC gateway used as an attachment. |
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.
|
created_at |
String |
Time when the resource was created. The UTC time is in the yyyy-MM-ddTHH:mm:ss format. |
updated_at |
String |
Time when the resource was updated. The UTC 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:
|
bandwidth_size |
Integer |
Bandwidth capacity, 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" } }
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.