Querying a Global Connection Bandwidth
Function
This API is used to query the details of a global connection bandwidth.
Calling Method
For details, see Calling APIs.
URI
GET /v3/{domain_id}/gcb/configs
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Account ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
User token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Request ID. |
configs |
Dynamic configuration items for purchasing a global connection bandwidth. |
Parameter |
Type |
Description |
---|---|---|
size_range |
Array of GlobalConnectionBandwidthSizeRange objects |
Bandwidth range of global connection bandwidths by billing option. |
charge_mode |
Array of strings |
List of supported billing options. |
services |
Array of strings |
Instance type. |
gcb_type |
Array of strings |
Bandwidth type. |
ratio_95peak_plus |
Integer |
Percentage of the minimum bandwidth in enhanced 95th percentile bandwidth billing. |
ratio_95peak_guar |
Integer |
Percentage of the minimum bandwidth in standard 95th percentile bandwidth billing. |
crossborder |
Boolean |
Whether a cross-border permit is approved. |
quotas |
Array of GlobalConnectionBandwidthQuotas objects |
Quota information. |
sla_level |
Array of strings |
Line grade. |
bind_limit |
Integer |
Maximum number of instances that are allowed to use a shared bandwidth. |
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. |
Parameter |
Type |
Description |
---|---|---|
type |
String |
Billing option of a global connection bandwidth. Value options:
|
min |
Integer |
Minimum global connection bandwidth, in Mbit/s. |
max |
Integer |
Maximum global connection bandwidth, in Mbit/s. |
Example Requests
Querying the details of a global connection bandwidth
GET https://{cc_endpoint}/v3/{domain_id}/gcb/configs
Example Responses
Status code: 200
The global connection bandwidth details have been queried.
{ "request_id" : "61126320a1802d5c6444f9d2d76526c2", "configs" : { "size_range" : [ { "min" : 2, "max" : 300, "type" : "bwd" } ], "charge_mode" : [ "bwd", 95, "95avr" ], "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 30 |
# coding: utf-8 import os 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 = os.environ["CLOUD_SDK_AK"] sk = os.environ["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 connection bandwidth details have been queried. |
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot