doc-exports/docs/ccn/api-ref/UpdateCentralNetworkConnection.html

Modifying the Bandwidth of a Central Network Connection

Function

This API is used to update a central network connection.

URI

PUT /v3/{domain_id}/gcn/central-network/{central_network_id}/connections/{connection_id}

Table 1 Path Parameters

Parameter	Mandatory	Type	Description
domain_id	Yes	String	Account ID.
central_network_id	Yes	String	Central network ID.
connection_id	Yes	String	ID of the connection 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_connection	Yes	UpdateCentralNetworkConnection object	Details of the central network connection to be updated. bandwidth_type: BandwidthPackage (billed by bandwidth or traffic) or TestBandwidth (free bandwidth for testing cross-region connectivity) global_connection_bandwidth_id: mandatory if bandwidth_type is BandwidthPackage and not required if bandwidth_type is TestBandwidth. bandwidth_size: mandatory if bandwidth_type is BandwidthPackage (the sum of cross-site connection bandwidths cannot exceed the capacity of the bandwidth package) and not required if bandwidth_type is TestBandwidth

Table 4 UpdateCentralNetworkConnection

Parameter	Mandatory	Type	Description
bandwidth_type	Yes	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	No	Long	Bandwidth range, in Mbit/s. This parameter is mandatory if bandwidth_type is BandwidthPackage and not required if bandwidth_type is TestBandwidth.
global_connection_bandwidth_id	No	String	Global connection bandwidth ID. This parameter is mandatory if bandwidth_type is BandwidthPackage and not required if bandwidth_type is TestBandwidth.

Response Parameters

Status code: 202

Table 5 Response body parameters

Parameter	Type	Description
request_id	String	Request ID.
central_network_connection	CentralNetworkConnection object	Connection on the central network.

Table 6 CentralNetworkConnection

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.
enterprise_project_id	String	ID of the enterprise project that the resource belongs to.
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. If bandwidth_type is set to TestBandwidth, no global connection bandwidth is bound, and this parameter is not displayed.
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	Long	Bandwidth range, in Mbit/s. If bandwidth_type is set to TestBandwidth, the bandwidth size is the default value, and this parameter is not displayed.
state	String	Central network connection status. AVAILABLE CREATING UPDATING DELETING FREEZING UNFREEZING RECOVERING FAILED DELETED APPROVING APPROVED UNAPPROVED
is_frozen	Boolean	Whether the resource is frozen.
connection_type	String	Type of a central network connection. ER-ER: peering connection between enterprise routers ER-GDGW: connection between an enterprise router and a global DC gateway ER-ER_ROUTE_TABLE: connection between an enterprise router and an enterprise router route table
connection_point_pair	Array of ConnectionPoint objects	Both ends of a central network connection. The length is fixed to an array of 2.
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.

Table 7 ConnectionPoint

Parameter	Type	Description
id	String	Instance ID.
project_id	String	Project ID.
region_id	String	Region ID.
site_code	String	Site code. You can obtain the code by calling the API for querying the site list of the global connection bandwidth.
instance_id	String	Instance ID at an end of a connection.
parent_instance_id	String	Parent resource ID of the instance at an end of a connection.
type	String	Type of the resource that can be added to a central network as an attachment. ER: enterprise router GDGW: global DC gateway ER_ROUTE_TABLE: enterprise router route table

Example Requests

Updating a cross-site connection on a central network

PUT /v3/{domain_id}/gcn/central-network/{central_network_id}/connections/{connection_id}

{
  "central_network_connection" : {
    "bandwidth_type" : "BandwidthPackage",
    "global_connection_bandwidth_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "bandwidth_size" : 20
  }
}

Example Responses

Status code: 202

The central network connection has been updated.

{
  "request_id" : "e108915cd5de228ef252be95ce6ef2c2",
  "central_network_connection" : {
    "id" : "eb350a5c-06c1-4b12-9ae4-3820f31faaa0",
    "name" : "er-connection",
    "domain_id" : "XXX",
    "enterprise_project_id" : "0",
    "central_network_id" : "43ad756e-2780-463e-a8ed-27a5bd77b7a7",
    "central_network_plane_id" : "238f60d5-ed1a-4508-8473-45509c530c8f",
    "bandwidth_type" : "TestBandwidth",
    "state" : "UPDATING",
    "is_frozen" : false,
    "connection_type" : "ER-ER",
    "connection_point_pair" : [ {
      "id" : "1c233723-234c-4b50-8fba-7072b4c6aa1a",
      "project_id" : "XXX",
      "region_id" : "region-abc",
      "site_code" : "region-abc",
      "instance_id" : "d238dd85-f769-485b-aa05-d20e1d3889df",
      "type" : "ER"
    }, {
      "id" : "8641d7f0-bd0c-49fe-8b70-3649cd7dd9b1",
      "project_id" : "XXX",
      "region_id" : "region-abc",
      "site_code" : "region-abc",
      "instance_id" : "96abbb18-4a77-4103-aa8e-b1c836154282",
      "type" : "ER"
    } ],
    "created_at" : "2023-10-09T08:02:43.31Z",
    "updated_at" : "2023-10-09T08:02:43.307Z"
  }
}

Status Codes

Status Code	Description
202	The central network connection has been updated.

Error Codes

See Error Codes.

Parent topic: Central Network Connections