Help Center/ Cloud Connect/ API Reference/ API/ Central Network Attachments/ Updating a Global DC Gateway on a Central Network

Updated on 2025-07-29 GMT+08:00

View PDF

Updating a Global DC Gateway on a Central Network

Function

This API is used to update a global DC gateway on a central network.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Account ID.
central_network_id	Yes	String	Central network ID.
gdgw_attachment_id	Yes	String	ID of the global DC gateway attachment on the central network.

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	UpdateCentralNetworkGdgwAttachment object	Details of the global DC gateway on the central network to be updated.

**Table 4** UpdateCentralNetworkGdgwAttachment
Parameter	Mandatory	Type	Description
name	No	String	Instance name.
description	No	String	Resource description. Angle brackets (<>) are not allowed.

Response Parameters

Status code: 200

**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 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: 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	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

Updating a global DC gateway on a central network

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

{
  "central_network_gdgw_attachment" : {
    "name" : "name",
    "description" : "description"
  }
}

Example Responses

Status code: 200

The global DC gateway on the central network has been updated.

{
  "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:13:18.045Z",
    "updated_at" : "2023-10-09T10:13:18.045Z",
    "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"
  }
}