Updating a Global Connection Bandwidth

Function

This API is used to update a global connection bandwidth.

URI

PUT /v3/{domain_id}/gcb/gcbandwidths/{id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Account ID.
id	Yes	String	Instance ID.

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
globalconnection_bandwidth	Yes	UpdateGlobalConnectionBandwidth object	Details about a global connection bandwidth.

**Table 4** UpdateGlobalConnectionBandwidth
Parameter	Mandatory	Type	Description
name	No	String	Instance name.
description	No	String	Resource description. Angle brackets (<>) are not allowed.
size	No	Integer	The capacity of a global connection bandwidth, in Mbit/s. Value range: 2 Mbit/s to 300 Mbit/s
charge_mode	No	String	Billing option. By default, billing by bandwidth capacity is enabled. Standard 95th percentile bandwidth billing is controlled using a whitelist. Value options: bwd: billing by bandwidth capacity 95: standard 95th percentile bandwidth billing 95avr: average daily 95th percentile bandwidth
sla_level	No	String	Class of a global connection bandwidth. There are three classes: platinum, gold, and silver. The default class is gold. Other options are controlled by whitelists. Pt: Platinum Au: Gold Ag: Silver
binding_service	No	String	Instance type. Cloud Connect: cloud connection GEIP: global EIP GCN: central network GSN: site network ALL: all instance types
spec_code_id	No	String	UUID of a line specification code.

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
request_id	String	Request ID.
globalconnection_bandwidth	GlobalConnectionBandwidth object	Details about a global connection bandwidth.

**Table 6** GlobalConnectionBandwidth
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.
bordercross	Boolean	Whether the global connection bandwidth is used for cross-border communications. true: cross-border communications false: non-cross-border communications
type	String	Type of a global connection bandwidth. TrsArea: cross-geographic-region bandwidth Area: geographic-region bandwidth SubArea: region bandwidth Region: multi-city bandwidth
binding_service	String	Instance type. Cloud Connect: cloud connection GEIP: global EIP GCN: central network GSN: site network ALL: all instance types
enterprise_project_id	String	ID of the enterprise project that the resource belongs to.
charge_mode	String	Billing option. By default, billing by bandwidth capacity is enabled. Standard 95th percentile bandwidth billing is controlled using a whitelist. Value options: bwd: billing by bandwidth capacity 95: standard 95th percentile bandwidth billing 95avr: average daily 95th percentile bandwidth
size	Integer	The capacity of a global connection bandwidth, in Mbit/s. Value range: 2 Mbit/s to 300 Mbit/s
sla_level	String	Class of a global connection bandwidth. There are three classes: platinum, gold, and silver. The default class is gold. Other options are controlled by whitelists. Pt: Platinum Au: Gold Ag: Silver
local_area	String	Name of a local access point. The x-language parameter in the header is used to control the language. The default language is English. zh-cn indicates Chinese.
remote_area	String	Name of a remote access point. The x-language parameter in the header is used to control the language. The default language is English. zh-cn indicates Chinese.
local_site_code	String	Code of the local access point.
remote_site_code	String	Code of s remote access point.
admin_state	String	Global connection bandwidth status. NORMAL: The bandwidth is normal. FREEZED: The bandwidth is frozen.
frozen	Boolean	Whether a global connection bandwidth is frozen. true: The bandwidth is frozen. false: The bandwidth is not frozen.
spec_code_id	String	UUID of a line specification code.
tags	Array of Tag objects	Resource tags.
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.
enable_share	Boolean	Whether a global connection bandwidth can be used by multiple instances. true: The bandwidth can be used by multiple instances. false: The bandwidth cannot be used by multiple instances.
instances	Array of GlobalConnectionBandwidthAssociatedInstance objects	The list of instances that the global connection bandwidth is bound to.

**Table 7** Tag
Parameter	Type	Description
key	String	Tag key. The key can contain a maximum of 128 Unicode characters, including letters, digits, hyphens (-), and underscores (_).
value	String	Tag value. The value can contain a maximum of 255 Unicode characters, including letters, digits, hyphens (-), underscores (_), and periods (.).

**Table 8** GlobalConnectionBandwidthAssociatedInstance
Parameter	Type	Description
id	String	Bound instance ID.
type	String	Bound instance type.
region_id	String	Region of the bound instance. The default value is global for global services.
project_id	String	Project ID of the bound instance.

Example Requests

Updating a global connection bandwidth

PUT https://{cc_endpoint}/v3/{domain_id}/gcb/gcbandwidths/{id}

{
  "globalconnection_bandwidth" : {
    "name" : "test",
    "description" : "Description",
    "size" : 5
  }
}

Example Responses

Status code: 200

The global connection bandwidth has been updated.

{
  "request_id" : "1b90e4762e3090961a30ca3a712dc0ed",
  "globalconnection_bandwidth" : {
    "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "name" : "name",
    "description" : "description",
    "domain_id" : "521bb3d98bed4c6c9ee8669bd0620f76",
    "bordercross" : false,
    "type" : "Region",
    "binding_service" : "CC",
    "enterprise_project_id" : "0c478f9e-73a4-4c45-b9bc-b2c3bfc0d4c0",
    "charge_mode" : "bwd",
    "size" : 100,
    "sla_level" : "Au",
    "local_site_code" : "site-def",
    "remote_site_code" : "site-abc",
    "frozen" : "false,",
    "spec_code_id" : "",
    "tags" : [ ],
    "created_at" : "2024-01-24T08:26:41.914Z",
    "updated_at" : "2024-01-24T08:26:41.914Z",
    "enable_share" : false,
    "instances" : [ ]
  }
}

Status Codes

Status Code	Description
200	The global connection bandwidth has been updated.

Error Codes

See Error Codes.

Parent Topic: Global Connection Bandwidths

Previous topic: Querying a Global Connection Bandwidth

Next topic: Deleting a Global Connection Bandwidth

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.