Help Center/ Cloud Connect/ API Reference/ API/ Bandwidth Packages/ Querying a Bandwidth Package

Updated on 2024-11-25 GMT+08:00

View PDF

Querying a Bandwidth Package

Function

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

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET /v3/{domain_id}/ccaas/bandwidth-packages/{id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Account ID.
id	Yes	String	Instance ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
request_id	String	Request ID.
bandwidth_package	BandwidthPackage object	Bandwidth package.

**Table 4** BandwidthPackage
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.
enterprise_project_id	String	ID of the enterprise project that the resource belongs to.
project_id	String	Project ID.
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.
resource_id	String	ID of the resource that the bandwidth package is bound to.
resource_type	String	Type of the resource that the bandwidth package is bound to. cloud_connection: a cloud connection
local_area_id	String	Geographic region. Cloud Connect is available in the following geographic regions: \| Chinese-Mainland \| Chinese mainland \| \| Asia-Pacific \| Asia Pacific \| \| Africa \| Southern Africa \| \| Western-Latin-America \| Western Latin America \| \| Eastern-Latin-America \| Eastern Latin America \| \| Northern-Latin-America \| Northern Latin America \|
remote_area_id	String	Geographic region. Cloud Connect is available in the following geographic regions: \| Chinese-Mainland \| Chinese mainland \| \| Asia-Pacific \| Asia Pacific \| \| Africa \| Southern Africa \| \| Western-Latin-America \| Western Latin America \| \| Eastern-Latin-America \| Eastern Latin America \| \| Northern-Latin-America \| Northern Latin America \|
spec_code	String	Specification code of the bandwidth package. bandwidth.aftoela: Southern Africa-Eastern Latin America on both the Chinese Mainland website and International website bandwidth.aftonla: Southern Africa-Northern Latin America on both the Chinese Mainland website and International website bandwidth.aftowla: Southern Africa-Western Latin America on both the Chinese Mainland website and International website bandwidth.aptoaf: Asia Pacific-Southern Africa on the International website bandwidth.aptoap: Asia Pacific on the International website bandwidth.aptoela: Asia Pacific-Eastern Latin America on both the Chinese Mainland website and International website bandwidth.aptonla: Asia Pacific-Northern Latin America on both the Chinese Mainland website and International website bandwidth.aptowla: Asia Pacific-Western Latin America on both the Chinese Mainland website and International website bandwidth.cmtoaf: Chinese mainland-Southern Africa on the International website bandwidth.cmtoap: Chinese mainland-Asia Pacific on the International website bandwidth.cmtocm: Chinese mainland on the International website bandwidth.cmtoela: Chinese mainland-Eastern Latin America on both the Chinese Mainland website and International website bandwidth.cmtonla: Chinese mainland-Northern Latin America on both the Chinese Mainland website and International website bandwidth.cmtowla: Chinese mainland-Western Latin America on both the Chinese Mainland website and International website bandwidth.elatoela: Eastern Latin America on both the Chinese Mainland website and International website bandwidth.elatonla: Eastern Latin America–Northern Latin America on both the Chinese Mainland website and International website bandwidth.wlatoela: Western Latin America-Eastern Latin America on both the Chinese Mainland website and International website bandwidth.wlatonla: Western Latin America–Northern Latin America on both the Chinese Mainland website and International website bandwidth.wlatowla: Western Latin America on both the Chinese Mainland website and International website
billing_mode	Integer	Billing mode of the bandwidth package on the Chinese Mainland website or the International website. 1: yearly/monthly on the Chinese Mainland website 2: yearly/monthly on the International website 3: pay-per-use on the Chinese Mainland website 4: pay-per-use on the International website 5: 95th percentile bandwidth billing on the Chinese Mainland website 6: 95th percentile bandwidth billing on the International website
tags	Array of Tag objects	Resource tags.
status	String	Status of the bandwidth package. ACTIVE: The bandwidth package is available.
admin_state_up	Boolean	Administrative status of the bandwidth package.
order_id	String	Order ID of the bandwidth package.
product_id	String	Product ID of the bandwidth package.
charge_mode	String	Bandwidth billing option. The bandwidth is billed by fixed bandwidth.
bandwidth	Integer	Bandwidth range specified for the bandwidth package.
interflow_mode	String	Bandwidth package applicability. Area: geographic regions Region: cloud regions

**Table 5** 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 (.).

Example Requests

Querying the details of a bandwidth package

GET https://{cc_endpoint}/v3/{domain_id}/ccaas/bandwidth-packages/{id}

Example Responses

Status code: 200

The details of a bandwidth package have been queried.

{
  "bandwidth_package" : {
    "bandwidth" : 5,
    "status" : "ACTIVE",
    "id" : "XXXXX",
    "name" : "test_bwp_name",
    "description" : "",
    "domain_id" : "XXX",
    "created_at" : "2023-09-20T08:37:15Z",
    "updated_at" : "2023-09-20T08:37:15Z",
    "project_id" : "XXX",
    "resource_type" : "",
    "resource_id" : "",
    "local_area_id" : "Chinese-Mainland",
    "remote_area_id" : "Chinese-Mainland",
    "admin_state_up" : true,
    "charge_mode" : "bandwidth",
    "billing_mode" : "3",
    "spec_code" : "bandwidth.cmtocm",
    "order_id" : "",
    "product_id" : "",
    "enterprise_project_id" : "0",
    "tags" : [ ],
    "interflow_mode" : "Area"
  },
  "request_id" : "39421c95a1d4308d964180f5d51d2f3c"
}

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.*;


public class ShowBandwidthPackageSolution {

    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();
        ShowBandwidthPackageRequest request = new ShowBandwidthPackageRequest();
        request.withId("{id}");
        try {
            ShowBandwidthPackageResponse response = client.showBandwidthPackage(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

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 = ShowBandwidthPackageRequest()
        request.id = "{id}"
        response = client.show_bandwidth_package(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.ShowBandwidthPackageRequest{}
	request.Id = "{id}"
	response, err := client.ShowBandwidthPackage(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     