Help Center/ Cloud Connect/ API Reference/ API/ Specifications/ Querying the Bandwidth Site List
Updated on 2024-11-25 GMT+08:00

Querying the Bandwidth Site List

Function

This API is used to query the bandwidth site list.

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/sites

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Account ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

site_code

No

String

Site code.

region_id

No

String

Region ID for query.

name

No

String

Name used for fuzzy search.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

bandwidth_package_sites

Array of BandwidthPackageSite objects

Site list.

request_id

String

Request ID.

page_info

PageInfo object

Pagination query information.

Table 4 BandwidthPackageSite

Parameter

Type

Description

id

String

Instance ID.

site_code

String

Site code.

region_id

String

Region ID.

site_type

String

Site type. The default type is region.

name_cn

String

Instance name.

name_en

String

Instance name.

description

String

Description. Angle brackets (<>) are not allowed.

created_at

String

Creation time. The UTC time is in the yyyy-MM-ddTHH:mm:ss format.

updated_at

String

Update time. The UTC time is in the yyyy-MM-ddTHH:mm:ss format.

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.

Example Requests

Querying the bandwidth site list

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

Example Responses

Status code: 200

The bandwidth site list has been queried.

{
  "bandwidth_package_sites" : [ {
    "id" : "e3371202-7e85-4c16-bb4b-4e3c092734f7",
    "created_at" : "2023-09-20T08:28:28Z",
    "updated_at" : "2023-09-20T08:28:28Z",
    "region_id" : "region-abc",
    "site_code" : "region-abc",
    "site_type" : "Region",
    "name_cn" : "Site abc",
    "name_en" : "site-abc",
    "description" : "description"
  } ],
  "request_id" : "e3371202-7e85-4c16-bb4b-4e3c092734f7",
  "page_info" : {
    "current_count" : 1
  }
}

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 ListBandwidthPackageSitesSolution {

    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();
        ListBandwidthPackageSitesRequest request = new ListBandwidthPackageSitesRequest();
        try {
            ListBandwidthPackageSitesResponse response = client.listBandwidthPackageSites(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 = ListBandwidthPackageSitesRequest()
        response = client.list_bandwidth_package_sites(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.ListBandwidthPackageSitesRequest{}
	response, err := client.ListBandwidthPackageSites(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 bandwidth site list has been queried.

Error Codes

See Error Codes.