Modifying the Bandwidth of a Central Network Connection
Function
This API is used to update a central network connection. Only the bandwidth capacity can be modified.
URI
PUT /v3/{domain_id}/gcn/central-network/{central_network_id}/connections/{connection_id}
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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
User token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
central_network_connection |
Yes |
Details of the central network connection to be updated.
|
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
bandwidth_type |
Yes |
String |
Bandwidth type. The bandwidth types are as follows:
|
global_connection_bandwidth_id |
No |
String |
Global connection bandwidth ID. |
bandwidth_size |
No |
Integer |
Bandwidth capacity, in Mbit/s. |
Response Parameters
Status code: 202
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Request ID. |
central_network_connection |
CentralNetworkConnection object |
Connection on the central network. |
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. |
bandwidth_type |
String |
Bandwidth type. The bandwidth types are as follows:
|
bandwidth_size |
Integer |
Bandwidth capacity, in Mbit/s. |
state |
String |
Central network connection status.
|
is_frozen |
Boolean |
Whether the resource is frozen. |
connection_type |
String |
Type of a central network connection.
|
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. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Instance ID. |
project_id |
String |
Project ID. |
region_id |
String |
Region ID. |
site_code |
String |
Site code. |
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.
|
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.