Help Center/ Direct Connect/ API Reference/ API/ Global DC Gateways/ Updating a Global DC Gateway

Updated on 2025-09-01 GMT+08:00

View PDF

Updating a Global DC Gateway

Function

This API is used to update a global DC gateway, for example, the name and description of a global DC gateway.

Calling Method

For details, see Calling APIs.

URI

PUT /v3/{project_id}/dcaas/global-dc-gateways/{global_dc_gateway_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID. Minimum: 0 Maximum: 36
global_dc_gateway_id	Yes	String	Specifies the global DC gateway ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header. Minimum: 0 Maximum: 10240

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
global_dc_gateway	Yes	UpdateGlobalDcGateway object	Specifies the global DC gateway to be updated.

**Table 4** UpdateGlobalDcGateway
Parameter	Mandatory	Type	Description
name	No	String	Specifies the name of the global DC gateway. Minimum: 0 Maximum: 64
description	No	String	Provides supplementary information about the global DC gateway. Minimum: 0 Maximum: 255
address_family	No	String	Specifies the IP address family of the global DC gateway. Minimum: 0 Maximum: 36

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
global_dc_gateway	GlobalDcGatewayEntry object	Specifies the global DC gateway.
request_id	String	Specifies the request ID. Minimum: 0 Maximum: 36

**Table 6** GlobalDcGatewayEntry
Parameter	Type	Description
id	String	Specifies the global DC gateway ID. Minimum: 0 Maximum: 36
tenant_id	String	Specifies the project ID. Minimum: 0 Maximum: 255
name	String	Specifies the name of the global DC gateway. Minimum: 0 Maximum: 64
description	String	Provides supplementary information about the global DC gateway. Minimum: 0 Maximum: 128
reason	String	Specifies the cause of the failure to create the global DC gateway. Minimum: 0 Maximum: 255
enterprise_project_id	String	Specifies the ID of the enterprise project that the global DC gateway belongs to. Minimum: 0 Maximum: 36
global_center_network_id	String	Specifies the ID of the central network that the global DC gateway is added to. Minimum: 0 Maximum: 36
bgp_asn	Long	Specifies the BGP ASN of the global DC gateway. Minimum: 0 Maximum: 65535
region_id	String	Specifies the region of the global DC gateway. Minimum: 0 Maximum: 36
location_name	String	Specifies the location where the underlying device of the global DC gateway is deployed. Minimum: 0 Maximum: 36
locales	LocalesBody object	Specifies the locale.
current_peer_link_count	Integer	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.
available_peer_link_count	Integer	Specifies the number of peer links that can be created for a global DC gateway.
admin_state_up	Boolean	Specifies the administrative status of the global DC gateway. true: The global DC gateway is available. false: The global DC gateway is frozen.
status	String	Specifies the status of the global DC gateway.- DOWN: The global DC gateway is faulty.- PENDING_UPDATE: The global DC gateway is being updated.- ACTIVE: The global DC gateway is available.- ERROR: An error occurred.
created_time	String	Specifies the time when the global DC gateway was created.
updated_time	String	Specifies the time when the global DC gateway was updated.
address_family	String	Specifies the IP address family of the global DC gateway. ipv4: Only IPv4 is supported. dual: Both IPv4 and IPv6 are supported.

**Table 7** LocalesBody
Parameter	Type	Description
en_us	String	Specifies the region name in English. Minimum: 0 Maximum: 255
zh_cn	String	Specifies the region name in Chinese. Minimum: 0 Maximum: 255

Example Requests

Updating a global DC gateway

PUT https://{dc_endpoint}/v3/b197c48159d44a66b32c538c3f8da89a/dcaas/global-dc-gateways/71f6ac9b-2745-4fb8-96c8-9d97d969c4b5

{
  "global_dc_gateway" : {
    "name" : "dgw-2c19"
  }
}

Example Responses

Status code: 200

Global DC gateway that has been updated

{
  "request_id" : "fa70b8d1f22787684bba9407779b8bf2",
  "global_dc_gateway" : {
    "enterprise_project_id" : "0",
    "name" : "dgw-2c19",
    "id" : "71f6ac9b-2745-4fb8-96c8-9d97d969c4b5",
    "tenant_id" : "b197c48159d44a66b32c538c3f8da89a",
    "description" : "",
    "status" : "DOWN",
    "admin_state_up" : true,
    "created_time" : "2024-12-12T07:33:19.000Z",
    "updated_time" : "2024-12-12T07:36:04.257Z",
    "bgp_asn" : 64512,
    "global_center_network_id" : null,
    "current_peer_link_count" : 0,
    "available_peer_link_count" : 3,
    "location_name" : null,
    "region_id" : null
  }
}