Creating a Global Connection Bandwidth
Function
This API is used to create a global connection bandwidth.
URI
POST /v3/{domain_id}/gcb/gcbandwidths
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Account ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
User token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
globalconnection_bandwidth |
Yes |
Details about a global connection bandwidth. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Instance name. |
description |
No |
String |
Resource description. Angle brackets (<>) are not allowed. |
bordercross |
Yes |
Boolean |
Whether the global connection bandwidth is used for cross-border communications (between the Chinese mainland and a country/region outside the Chinese mainland).
|
type |
Yes |
String |
Type of a global connection bandwidth.
|
enterprise_project_id |
No |
String |
ID of the enterprise project that the resource belongs to. |
tags |
No |
Array of Tag objects |
Resource tags. |
charge_mode |
Yes |
String |
Billing option. By default, billing by bandwidth capacity is enabled. Standard 95th percentile bandwidth billing is controlled using a whitelist. Value options:
|
size |
Yes |
Integer |
The capacity of a global connection bandwidth, in Mbit/s. Value range: 2 Mbit/s to 300 Mbit/s |
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.
|
local_area |
No |
String |
Local access point. This parameter is used together with remote_area to describe the applicability of a global connection bandwidth. The value can contain 1 to 64 characters, including digits, letters, underscores (_), hyphens (-), and periods (.). The site code is obtained through API calls. If the bandwidth type is Region, this parameter is optional. For other types, this parameter is mandatory. |
remote_area |
No |
String |
Remote access point. This parameter is used together with local_area to describe the applicability of a global connection bandwidth. The value can contain 1 to 64 characters, including digits, letters, underscores (_), hyphens (-), and periods (.). The site code is obtained through API calls. If the bandwidth type is Region, this parameter is optional. For other types, this parameter is mandatory. |
spec_code_id |
No |
String |
UUID of a line specification code. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
key |
Yes |
String |
Tag key. The key can contain a maximum of 128 Unicode characters, including letters, digits, hyphens (-), and underscores (_). |
value |
No |
String |
Tag value. The value can contain a maximum of 255 Unicode characters, including letters, digits, hyphens (-), underscores (_), and periods (.). |
Response Parameters
Status code: 201
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Request ID. |
globalconnection_bandwidth |
GlobalConnectionBandwidth object |
Details about a global connection bandwidth. |
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 (between the Chinese mainland and a country/region outside the Chinese mainland).
|
type |
String |
Type of a global connection bandwidth.
|
binding_service |
String |
Instance type.
|
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:
|
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.
|
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.
|
frozen |
Boolean |
Whether a global connection bandwidth is 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.
|
instances |
Array of GlobalConnectionBandwidthAssociatedInstance objects |
The list of instances that the global connection bandwidth is bound to. |
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 (.). |
Example Requests
-
Creating a multi-city bandwidth
POST https://{cc_endpoint}/v3/{domain_id}/gcb/gcbandwidths { "globalconnection_bandwidth" : { "name" : "test_region", "description" : "Description", "bordercross" : false, "type" : "Region", "charge_mode" : "bwd", "size" : 5 } }
-
Creating a geographic-region bandwidth
POST https://{cc_endpoint}/v3/{domain_id}/gcb/gcbandwidth { "globalconnection_bandwidth" : { "name" : "test_area", "description" : "Description", "bordercross" : false, "type" : "Area", "charge_mode" : "bwd", "size" : 5, "local_area" : "site-abc", "remote_area" : "site-def" } }
Example Responses
Status code: 201
The global connection bandwidth has been created.
{ "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 |
---|---|
201 |
The global connection bandwidth has been created. |
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.