Help Center/ Cloud Connect/ API Reference/ API/ Global Private Bandwidths/ Querying the Global Private Bandwidth List

Updated on 2024-03-29 GMT+08:00

View PDF

Querying the Global Private Bandwidth List

Function

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

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

Calling Method

For details, see Calling APIs.

URI

GET /v3/{domain_id}/gcb/gcbandwidths

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Account ID. Minimum: 10 Maximum: 32

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Number of records on each page. Value range: 1 to 1000 Minimum: 1 Maximum: 1000 Default: 1000
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. Minimum: 1 Maximum: 4096
id	No	Array	Resource ID. Multiple IDs can be queried. Array Length: 1 - 20
name	No	Array	Resource name. Multiple names can be queried. Array Length: 1 - 20
enterprise_project_id	No	Array	Enterprise project IDs. Array Length: 1 - 20
instance_id	No	Array	Bound instance ID used for listing global private bandwidths. Array Length: 1 - 10
instance_type	No	Array	Instance type used for listing global private bandwidths. Cloud Connect: cloud connection GEIP: Global EIP GCN: central network GSN: site network Array Length: 1 - 10
binding_service	No	Array	Instance type used for listing global private bandwidths. Cloud Connect: cloud connection GEIP: Global EIP GCN: central network GSN: site network Array Length: 1 - 10
type	No	Array	Bandwidth type used for listing global private bandwidths. TrsArea: cross-geographic-region bandwidth Area: geographic-region bandwidth SubArea: region bandwidth Region: multi-city bandwidth Array Length: 1 - 10
admin_state	No	Array	Status used for listing global private bandwidths. NORMAL: The global private bandwidth is available. FREEZED: The global private bandwidth is frozen. Array Length: 1 - 10
charge_mode	No	Array	Billing option used for listing global private bandwidths. bwd: billing by bandwidth 95: standard 95th percentile bandwidth billing Array Length: 1 - 10

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. Minimum: 0 Maximum: 2000000

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
request_id	String	Resource ID. Minimum: 32 Maximum: 36
page_info	PageInfo object	Pagination query information.
globalconnection_bandwidths	Array of GlobalConnectionBandwidth objects	Response body for querying the global private bandwidth list. Array Length: 1 - 2000

**Table 5** PageInfo
Parameter	Type	Description
next_marker	String	Backward pagination identifier. Minimum: 1 Maximum: 4096
previous_marker	String	Forward pagination identifier. Minimum: 1 Maximum: 4096
current_count	Integer	Number of the resources in the current list. Minimum: 0 Maximum: 2000

**Table 6** GlobalConnectionBandwidth
Parameter	Type	Description
id	String	Resource ID.
name	String	Resource name.
description	String	Resource description. Angle brackets (<>) are not allowed. Minimum: 0 Maximum: 255
domain_id	String	ID of the account that the instance belongs to.
bordercross	Boolean	Whether the global private bandwidth is used for cross-border communications (between the Chinese mainland and a country/region outside the Chinese mainland). True: cross-border communications False: non-cross-border communications
type	String	Type of a global private 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 virtual gateway belongs to. Minimum: 1 Maximum: 36
charge_mode	String	Billing option. By default, billing by bandwidth is enabled. Standard 95th percentile bandwidth billing is controlled using a whitelist. bwd: billing by bandwidth 95: standard 95th percentile bandwidth billing
size	Integer	Range of a global private bandwidth, in Mbit/s. Bandwidth range: 2 Mbit/s to 300 Mbit/s Minimum: 2 Maximum: 300
sla_level	String	Class of a global private 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 Default: Au Minimum: 1 Maximum: 36
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. Minimum: 1 Maximum: 36
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. Minimum: 1 Maximum: 36
local_site_code	String	Code of the local access point. Minimum: 1 Maximum: 36
remote_site_code	String	Code of s remote access point. Minimum: 1 Maximum: 36
admin_state	String	Global private bandwidth status. NORMAL: The bandwidth is normal. FREEZED: The bandwidth is frozen.
frozen	Boolean	Whether a global private bandwidth is frozen. true: The bandwidth is frozen. false: The bandwidth is not frozen.
spec_code_id	String	UUID of a line specification code. Minimum: 1 Maximum: 36
tags	Array of Tag objects	Resource tags. Array Length: 1 - 20
created_at	String	Time when the resource was created. The time is in the yyyy-MM-ddTHH:mm:ss format.
updated_at	String	Time when the resource was updated. The time must be in the yyyy-MM-ddTHH:mm:ss format.
enable_share	Boolean	Whether a global private 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 private bandwidth is bound to. Array Length: 0 - 200

**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. Minimum: 0 Maximum: 36
type	String	Bound instance type. Minimum: 0 Maximum: 36
region_id	String	Region of the bound instance. The default value is global for global services. Minimum: 0 Maximum: 36
project_id	String	Project ID of the bound instance. Minimum: 0 Maximum: 36

Example Requests

Querying the global private bandwidth list

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

Example Responses

Status code: 200

The global private 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" : "CC",
    "enterprise_project_id" : "0c478f9e-73a4-4c45-b9bc-b2c3bfc0d4c0",
    "charge_mode" : "bwd",
    "size" : 100,
    "sla_level" : "Au",
    "local_site_code" : "cn-south-guangzhou",
    "remote_site_code" : "cn-north-beijing4",
    "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
  }
}

SDK Sample Code

The SDK sample code is as follows.

      
       
         
         
           package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.cc.v3.region.CcRegion;
import com.huaweicloud.sdk.cc.v3.*;
import com.huaweicloud.sdk.cc.v3.model.*;

import java.util.List;
import java.util.ArrayList;

public class ListGlobalConnectionBandwidthsSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        CcClient client = CcClient.newBuilder()
                .withCredential(auth)
                .withRegion(CcRegion.valueOf("<YOUR REGION>"))
                .build();
        ListGlobalConnectionBandwidthsRequest request = new ListGlobalConnectionBandwidthsRequest();
        request.withBindingService();
        request.withType();
        request.withChargeMode();
        request.withLimit(<limit>);
        request.withMarker("<marker>");
        request.withId();
        request.withName();
        request.withEnterpriseProjectId();
        try {
            ListGlobalConnectionBandwidthsResponse response = client.listGlobalConnectionBandwidths(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

          

        

      
     

      
       
         
         
           # coding: utf-8

from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdkcc.v3.region.cc_region import CcRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcc.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = GlobalCredentials(ak, sk) \

    client = CcClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CcRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListGlobalConnectionBandwidthsRequest()
        request.binding_service = 
        request.type = 
        request.charge_mode = 
        request.limit = <limit>
        request.marker = "<marker>"
        request.id = 
        request.name = 
        request.enterprise_project_id = 
        response = client.list_global_connection_bandwidths(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

          

        

      
     

      
       
         
         
           package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    cc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := cc.NewCcClient(
        cc.CcClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListGlobalConnectionBandwidthsRequest{}
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	response, err := client.ListGlobalConnectionBandwidths(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     