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

Querying the Global Connection Bandwidth List

Function

This API is used to query the global connection bandwidth list.

Parameters marker and limit are used for pagination query. The two parameters take effect only when they are used together.

URI

GET /v3/{domain_id}/gcb/gcbandwidths

Table 1 Path Parameters

Parameter	Mandatory	Type	Description
domain_id	Yes	String	Account ID.

Table 2 Query Parameters

Parameter	Mandatory	Type	Description
limit	No	Integer	Number of records returned on each page. The value ranges from 1 to 2000.
marker	No	String	Pagination query information. You can obtain the marker values from the response of the last API call. You can enter the marker value of the previous page or the next page. If you enter the marker value of the previous page, the previous page will be queried. If you enter the marker value of the next page, the next page will be queried. During pagination query, the query criteria, including the filters, sorting criteria, and the limit value, cannot be modified.
id	No	Array of strings	Resource ID. Multiple IDs can be queried.
name	No	Array of strings	The resource name used for query. Multiple names can be specified for query.
enterprise_project_id	No	Array of strings	Enterprise project IDs.
instance_id	No	Array of strings	Bound instance ID used for listing global connection bandwidths.
instance_type	No	Array of strings	Bound instance type used for listing global connection bandwidths. Instance type: CC: cloud connection (not supported) GEIP: global EIP (not supported) GCN: central network GSN: site network (not supported)
binding_service	No	Array of strings	Bound instance type used for listing global connection bandwidths. Instance type: CC: cloud connection (not supported) GEIP: global EIP (not supported) GCN: central network GSN: site network (not supported)
type	No	Array of strings	Bandwidth type used for listing global connection bandwidths. Bandwidth type: TrsArea: cross-geographic-region bandwidth (not supported) Area: geographic-region bandwidth SubArea: region bandwidth (not supported) Region: multi-city bandwidth (not supported)
admin_state	No	Array of strings	Status used for listing global connection bandwidths. NORMAL: The global connection bandwidth is available. FREEZED: The global connection bandwidth is frozen.
charge_mode	No	Array of strings	Billing option used for querying global connection bandwidths. bwd: billed by bandwidth 95: standard 95th percentile bandwidth billing 95avr: average daily 95th percentile bandwidth billing

Request Parameters

Table 3 Request header parameters

Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter	Type	Description
request_id	String	Request ID.
page_info	PageInfo object	Pagination query information.
globalconnection_bandwidths	Array of GlobalConnectionBandwidth objects	Response body for querying the global connection bandwidth list.

Table 5 PageInfo

Parameter	Type	Description
next_marker	String	Backward pagination identifier.
previous_marker	String	Forward pagination identifier.
current_count	Integer	Number of the resources in the current list.

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	Cross-border attribute of a global connection bandwidth.
type	String	Type of a global connection bandwidth. TrsArea: cross-geographic-region bandwidth (not supported) Area: geographic-region bandwidth SubArea: region bandwidth (not supported) Region: multi-city bandwidth (not supported)
binding_service	String	Instance type. CC: cloud connection (not supported) GEIP: global EIP (not supported) GCN: central network GSN: site network (not supported) 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 is enabled. Standard 95th percentile bandwidth billing is controlled using a whitelist. Range: bwd: billing by bandwidth 95: standard 95th percentile bandwidth billing (not supported) 95avr: average daily 95th percentile bandwidth billing (not supported)
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 the local access point.
remote_area	String	Name of the remote access point.
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.
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.
directional_connections	Array of DirectionalConnection objects	Directional connections.
enable_share	Boolean	Whether a global connection bandwidth can be used by multiple instances. Range: 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.
eps_id	String	ID of the enterprise project that the instance belongs to. This parameter has been discarded. Please do not use it.
billing_info	String	Billing information. This parameter has been discarded. Please do not use it.
bandwidth	Integer	Range of a global connection bandwidth, in Mbit/s. This parameter has been discarded. Please do not use it.
bandwidth_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 This parameter has been discarded. Please do not use it.
instance_id	String	Bound instance ID. This parameter has been discarded. Please do not use it.
instance_type	Integer	Bound instance type. This parameter has been discarded. Please do not use it.
instance_region_id	String	Region of the bound instance. This parameter has been discarded. Please do not use it.
instance_project_id	Integer	Project ID of the bound instance. This parameter has been discarded. Please do not use it.

Table 7 DirectionalConnection

Parameter	Type	Description
name	String	Instance name.
id	String	Instance ID.
local_site_code	String	Code of the local access point.
remote_site_code	String	Code of s remote access point.

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

Querying the global connection bandwidth list

GET https://{cc_endpoint}/v3/{domain_id}/gcb/gcbandwidths

Example Responses

Status code: 200

The global connection bandwidth list has been queried.

{
  "request_id" : "61126320a1802d5c6444f9d2d76526c2",
  "globalconnection_bandwidths" : [ {
    "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "name" : "name",
    "description" : "description",
    "domain_id" : "521bb3d98bed4c6c9ee8669bd0620f76",
    "bordercross" : false,
    "type" : "Region",
    "binding_service" : "ALL",
    "enterprise_project_id" : "0c478f9e-73a4-4c45-b9bc-b2c3bfc0d4c0",
    "charge_mode" : "bwd",
    "size" : 100,
    "sla_level" : "Au",
    "local_site_code" : "site-abc",
    "remote_site_code" : "site-def",
    "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" : [ ]
  } ],
  "page_info" : {
    "next_marker" : "XXX",
    "previous_marker" : "XXX",
    "current_count" : 1
  }
}

Status Codes

Status Code	Description
200	The global connection bandwidth list has been queried.

Error Codes

See Error Codes.

Parent topic: Global Connection Bandwidths