Help Center/ Cloud Connect/ API Reference/ API/ Global Private Bandwidths/ Querying a Global Private Bandwidth
Updated on 2024-03-29 GMT+08:00

Querying a Global Private Bandwidth

Function

This API is used to query the details of a global private bandwidth.

Calling Method

For details, see Calling APIs.

URI

GET /v3/{domain_id}/gcb/configs

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Account ID.

Minimum: 10

Maximum: 32

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token.

Minimum: 0

Maximum: 2000000

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

request_id

String

Resource ID.

Minimum: 32

Maximum: 36

configs

ListGlobalConnectionBandwidthConfigs object

Dynamic configuration items for purchasing a global private bandwidth.

Table 4 ListGlobalConnectionBandwidthConfigs

Parameter

Type

Description

size_range

Array of GlobalConnectionBandwidthSizeRange objects

Bandwidth range of global private bandwidths by billing option.

Array Length: 0 - 10

charge_mode

Array of strings

List of supported billing options.

Array Length: 0 - 10

services

Array of strings

Instance type.

Array Length: 0 - 10

gcb_type

Array of strings

Bandwidth type.

Array Length: 0 - 10

ratio_95peak_plus

Integer

Percentage of the minimum bandwidth in enhanced 95th percentile bandwidth billing.

Minimum: 0

Maximum: 100

ratio_95peak_guar

Integer

Percentage of the minimum bandwidth in standard 95th percentile bandwidth billing.

Minimum: 0

Maximum: 100

crossborder

Boolean

Whether a cross-border permit is approved.

quotas

Array of GlobalConnectionBandwidthQuotas objects

Quota information.

Array Length: 1 - 10

sla_level

Array of strings

Line grade.

Array Length: 1 - 10

bind_limit

Integer

Maximum number of instances that are allowed to use a shared bandwidth.

Minimum: 0

Maximum: 2000

enable_area_bandwidth

Boolean

Whether to enable the geographic region bandwidth.

enable_change_95

Boolean

Whether standard 95th percentile bandwidth billing can be changed to billing by bandwidth.

enable_spec_code

Boolean

Whether multiple line specifications are supported.

Table 5 GlobalConnectionBandwidthSizeRange

Parameter

Type

Description

type

String

Billing option of a global private bandwidth.

Value options:

bwd: billing by bandwidth 95: standard 95th percentile bandwidth billing

Minimum: 0

Maximum: 64

min

Integer

Minimum global private bandwidth, in Mbit/s.

Minimum: 1

Maximum: 2147483647

max

Integer

Maximum global private bandwidth, in Mbit/s.

Minimum: 1

Maximum: 2147483647

Table 6 GlobalConnectionBandwidthQuotas

Parameter

Type

Description

quota

Integer

Quotas.

Minimum: 0

Maximum: 2147483647

used

Integer

Used quotas.

Minimum: 0

Maximum: 2147483647

type

String

Quota type.

  • gcb.size: global private bandwidth range

  • gcb.count: number of global private bandwidths

Example Requests

Querying the details of a global private bandwidth

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

Example Responses

Status code: 200

The global private bandwidth details have been queried.

{
  "request_id" : "61126320a1802d5c6444f9d2d76526c2",
  "configs" : {
    "size_range" : [ {
      "min" : 2,
      "max" : 300,
      "type" : "bwd"
    } ],
    "charge_mode" : [ "bwd", 95 ],
    "services" : [ "GEIP", "CC", "GCN", "GSN" ],
    "gcb_type" : [ "Region", "SubArea", "Area", "TrsArea" ],
    "ratio_95peak_guar" : 0,
    "crossborder" : false,
    "quotas" : [ {
      "quota" : 99999999,
      "used" : 3451,
      "type" : "gcb.size"
    }, {
      "quota" : 10000,
      "used" : 16,
      "type" : "gcb.count"
    } ],
    "bind_limit" : 200,
    "sla_level" : [ "Pt", "Au", "Ag" ]
  }
}

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
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.*;


public class ListGlobalConnectionBandwidthConfigsSolution {

    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();
        ListGlobalConnectionBandwidthConfigsRequest request = new ListGlobalConnectionBandwidthConfigsRequest();
        try {
            ListGlobalConnectionBandwidthConfigsResponse response = client.listGlobalConnectionBandwidthConfigs(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());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# 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 = ListGlobalConnectionBandwidthConfigsRequest()
        response = client.list_global_connection_bandwidth_configs(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
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.ListGlobalConnectionBandwidthConfigsRequest{}
	response, err := client.ListGlobalConnectionBandwidthConfigs(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

The global private bandwidth details have been queried.

Error Codes

See Error Codes.