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

查询带宽包列表

功能介绍

查询带宽包列表。

分页查询使用的参数为marker、limit。marker和limit一起使用时才会生效,单独使用无效。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

String

账号ID。

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

每页返回的个数。

取值范围:1~1000。

marker

String

翻页信息,从上次API调用返回的翻页数据中获取,可填写前一页marker或者后一页marker,填入前一页previous_marker就向前翻页,后一页next_marker就向后翻页。 翻页过程中,查询条件不能修改,包括过滤条件、排序条件、limit。

id

Array of arrays

根据ID查询,可查询多个ID。

name

Array of strings

根据名字查询,可查询多个名字。

enterprise_project_id

Array of strings

根据企业项目ID过滤列表。

cloud_connection_id

Array of arrays

根据云连接的ID过滤列表。

status

Array of strings

根据状态过滤带宽包实例列表。ACTIVE:表示状态可用。

billing_mode

Array of strings

根据计费方式过滤带宽包实例列表。

resource_id

Array of strings

根据绑定的资源ID过滤带宽包实例列表。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

request_id

String

请求ID。

page_info

PageInfo object

分页查询页的信息。

bandwidth_packages

Array of BandwidthPackage objects

带宽包实例列表。

表5 PageInfo

参数

参数类型

描述

next_marker

String

向后分页标识符。

previous_marker

String

向前分页标识符。

current_count

Integer

当前列表中资源数量。

表6 BandwidthPackage

参数

参数类型

描述

id

String

实例ID。

name

String

实例名称。

description

String

实例描述。不支持 <>。

domain_id

String

实例所属账号ID。

enterprise_project_id

String

实例所属企业项目ID。

project_id

String

实例所属项目ID。

created_at

String

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

updated_at

String

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

resource_id

String

带宽包实例绑定的资源ID。

resource_type

String

带宽包实例绑定的资源类型。

cloud_connection: 云连接实例。

local_area_id

String

本端大区。

云连接支持的大区有:

| Chinese-Mainland | 中国大陆 |

| Asia-Pacific | 亚太 |

| Africa | 非洲 |

| Western-Latin-America | 拉美西 |

| Eastern-Latin-America | 拉美东 |

| Northern-Latin-America | 拉美北 |

remote_area_id

String

本端大区。

云连接支持的大区有:

| Chinese-Mainland | 中国大陆 |

| Asia-Pacific | 亚太 |

| Africa | 非洲 |

| Western-Latin-America | 拉美西 |

| Eastern-Latin-America | 拉美东 |

| Northern-Latin-America | 拉美北 |

spec_code

String

带宽包实例的规格编码。

bandwidth.aftoela:大陆站+国际站南非-拉美东

bandwidth.aftonla:大陆站+国际站南非-拉美北

bandwidth.aftowla:大陆站+国际站南非-拉美西

bandwidth.aptoaf:国际站亚太-南非

bandwidth.aptoap:国际站亚太-亚太

bandwidth.aptoela:大陆站+国际站亚太-拉美东

bandwidth.aptonla:大陆站+国际站亚太-拉美北

bandwidth.aptowla:大陆站+国际站亚太-拉美西

bandwidth.cmtoaf:国际站中国大陆-南非

bandwidth.cmtoap:国际站中国大陆-亚太

bandwidth.cmtocm:国际站中国大陆-中国大陆

bandwidth.cmtoela:大陆站+国际站中国大陆-拉美东

bandwidth.cmtonla:大陆站+国际站中国大陆-拉美北

bandwidth.cmtowla:大陆站+国际站中国大陆-拉美西

bandwidth.elatoela:大陆站+国际站拉美东-拉美东

bandwidth.elatonla:大陆站+国际站拉美东-拉美北

bandwidth.wlatoela:大陆站+国际站拉美西-拉美东

bandwidth.wlatonla:大陆站+国际站拉美西-拉美北

bandwidth.wlatowla:大陆站+国际站拉美西-拉美西

billing_mode

Integer

带宽包实例在大陆站或国际站的计费方式。

1:大陆站包周期。

2:国际站包周期。

3:大陆站按需计费。

4:国际站按需计费。

5:大陆站按95方式计费。

6:国际站按95方式计费。

tags

Array of Tag objects

实例标签。

status

String

带宽包实例的状态。ACTIVE表示状态

admin_state_up

Boolean

带宽包实例的管理状态。

order_id

String

带宽包实例的订单ID。

product_id

String

带宽包实例的产品ID。

charge_mode

String

带宽包实例的计费方式。

bandwidth是按带宽计费。

bandwidth

Integer

带宽包实例中的带宽值。

interflow_mode

String

互通类型:

  • Area: 大区互通

  • Region: 城域互通

表7 Tag

参数

参数类型

描述

key

String

标签键,最大长度128个unicode字符,格式为大小写字母,数字,中划线“-”,下划线“_”,中文。

value

String

标签值,最大长度255个unicode字符,格式为大小写字母,数字,中划线“-”,下划线“_”,点“.”,中文。

请求示例

查询带宽包实例列表

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

响应示例

状态码: 200

查询带宽包实例列表成功。

{
  "request_id" : "61126320a1802d5c6444f9d2d76526c2",
  "bandwidth_packages" : [ {
    "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"
  } ],
  "page_info" : {
    "next_marker" : "XXX",
    "previous_marker" : "XXX",
    "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 ListBandwidthPackagesSolution {

    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();
        ListBandwidthPackagesRequest request = new ListBandwidthPackagesRequest();
        try {
            ListBandwidthPackagesResponse response = client.listBandwidthPackages(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 = ListBandwidthPackagesRequest()
        response = client.list_bandwidth_packages(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.ListBandwidthPackagesRequest{}
	response, err := client.ListBandwidthPackages(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

查询带宽包实例列表成功。

错误码

请参见错误码

相关文档