文档首页/ 云连接 CC/ API参考/ API/ 规格管理/ 查询带宽包站点列表
更新时间:2024-11-14 GMT+08:00
分享

查询带宽包站点列表

功能介绍

查询带宽包站点列表。

调用方法

请参见如何调用API

URI

GET https://cc.myhuaweicloud.com/v3/{domain_id}/ccaas/bandwidth-packages/sites

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

String

账号ID。

表2 Query参数

参数

是否必选

参数类型

描述

site_code

String

根据站点编码进行查询。

region_id

String

根据区域ID进行查询。

name

String

根据名称模糊查询。

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

bandwidth_package_sites

Array of BandwidthPackageSite objects

站点列表表。

request_id

String

请求ID。

page_info

PageInfo object

分页查询页的信息。

表4 BandwidthPackageSite

参数

参数类型

描述

id

String

实例ID。

site_code

String

站点编码。

region_id

String

RegionID。

site_type

String

站点类型。默认Region级别。

name_cn

String

实例名称。

name_en

String

实例名称。

description

String

描述。不支持 <>。

created_at

String

创建时间。UTC时间格式,yyyy-MM-ddTHH:mm:ss。

updated_at

String

更新时间。UTC时间格式,yyyy-MM-ddTHH:mm:ss。

表5 PageInfo

参数

参数类型

描述

next_marker

String

向后分页标识符。

previous_marker

String

向前分页标识符。

current_count

Integer

当前列表中资源数量。

请求示例

查询带宽包站点列表。

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

响应示例

状态码: 200

查询带宽包站点列表成功。

{
  "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" : "站点abc",
    "name_en" : "site-abc",
    "description" : "description"
  } ],
  "request_id" : "e3371202-7e85-4c16-bb4b-4e3c092734f7",
  "page_info" : {
    "current_count" : 1
  }
}

SDK代码示例

SDK代码示例如下。

 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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

查询带宽包站点列表成功。

错误码

请参见错误码

相关文档