# 通过标签过滤带宽包实例 - ListBandwidthPackagesByTags #### 功能介绍 通过标签过滤带宽包实例。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CC/doc?api=ListBandwidthPackagesByTags&version=v3)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-cc/cc_02_0002.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | cc:bandwidthPackages:list | List | bandwidthPackage \* | - | - | - | #### URI POST /v3/{domain_id}/ccaas/bandwidth-packages/filter 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | domain_id | 是 | String | 用户的账号ID，即租户ID，用于标识资源所属的华为云账号。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 否 | String | 用户Token，即用户的认证令牌，用于验证用户身份和权限。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | tags | 是 | Array of [MultivaluedTag] objects | 包含标签。 | 表4MultivaluedTag | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key | 是 | String | 标签键，最大长度128个unicode字符，格式为大小写字母，数字，中划线"-"，下划线"_"，中文。 | | values | 是 | Array of strings | 相同键的值列表 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | request_id | String | 请求ID。 | | page_info | [PageInfo] object | 分页查询页的信息。 | | bandwidth_packages | Array of [BandwidthPackage] objects | 带宽包实例列表。 | 表6PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | next_marker | String | 向后分页标识符。 | | previous_marker | String | 向前分页标识符。 | | current_count | Integer | 当前列表中资源数量。 | 表7BandwidthPackage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | - 参数解释：实例ID，即资源的唯一标识符，采用32位十六进制格式。 - 约束限制：长度为32个字符，只能包含十六进制数字（0-9，a-f，A-F）。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | name | String | - 参数解释：实例名称，用于标识和区分不同的实例。 - 约束限制：长度范围为1\~64个字符，只能由中文、英文字母、数字、下划线（_）、中划线（-）、点（.）组成。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | description | String | - 参数解释：实例的描述信息，用于记录实例的用途、归属部门等辅助信息。 - 约束限制：长度范围为0\~255个字符，不能包含"\<"和"\>"字符。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | domain_id | String | 实例所属账号ID。 | | enterprise_project_id | String | - 参数解释：实例所属的企业项目ID，用于标识资源所属的企业项目，实现企业内部资源的隔离和管理。 - 约束限制：最大长度不超过36字符，符合UUID格式或为字符串"0"。 - 取值范围：不涉及。 - 默认取值："0"表示默认企业项目。 | | 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 | - 参数解释：本端大区ID，用于标识带宽包或云连接实例的本端地理大区。 - 约束限制：长度范围为0\~36个字符，必须为有效的大区标识。 - 取值范围： - Chinese-Mainland: 中国大陆，包含中国大陆各个区域 - Asia-Pacific: 亚太，包含亚太地区各个国家 - Africa: 非洲，包含非洲地区各个国家 - Western-Latin-America: 拉美西，包含拉丁美洲西部地区 - Eastern-Latin-America: 拉美东，包含拉丁美洲东部地区 - Northern-Latin-America: 拉美北，包含拉丁美洲北部地区 - 默认取值：不涉及。 | | remote_area_id | String | - 参数解释：对端大区ID，用于标识带宽包或云连接实例的对端地理大区。 - 约束限制：长度范围为0\~36个字符，必须为有效的大区标识。 - 取值范围： - Chinese-Mainland: 中国大陆，包含中国大陆各个区域 - Asia-Pacific: 亚太，包含亚太地区各个国家 - Africa: 非洲，包含非洲地区各个国家 - Western-Latin-America: 拉美西，包含拉丁美洲西部地区 - Eastern-Latin-America: 拉美东，包含拉丁美洲东部地区 - Northern-Latin-America: 拉美北，包含拉丁美洲北部地区 - 默认取值：不涉及。 - Asia-Pacific: 亚太 - Africa: 非洲 - Western-Latin-America: 拉美西 - Eastern-Latin-America: 拉美东 - Northern-Latin-America: 拉美北 | | spec_code | String | - 参数解释：带宽包实例的规格编码，用于标识带宽包的产品规格类型。 - 约束限制：长度范围为0\~32个字符，必须为有效的规格编码。 - 取值范围：不涉及。 - 默认取值：不涉及。 - 获取方式：通过查询带宽包规格接口获取可用的规格编码。 | | billing_mode | Integer | 带宽包实例在大陆站或国际站的计费方式，有效值： - 1：大陆站包周期。 - 2：国际站包周期。 - 3：大陆站按需计费。 - 4：国际站按需计费。 - 5：大陆站按95方式计费。 - 6：国际站按95方式计费。 - 7：大陆站按日95方式计费。 - 8：国际站按日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: 城域互通 | 表8Tag | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | - 参数解释：标签键，用于标识和分类资源的标签属性名。 - 约束限制：最大长度128个unicode字符，不能为空，不能以空格开头或结尾，不能以"*sys*"开头。只能包含大小写字母、数字、中划线"-"、下划线"_"、点"."、冒号":"、等号"="、加号"+"、艾特符号"@"、中文字符。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | value | String | - 参数解释：标签值，与标签键对应的标签属性值，用于提供更具体的资源分类信息。 - 约束限制：最大长度255个unicode字符，可以为空，只能包含大小写字母、数字、中划线"-"、下划线"_"、点"."、冒号":"、等号"="、加号"+"、艾特符号"@"、中文字符、斜杠"/"。 - 取值范围：不涉及。 - 默认取值：不涉及。 | #### 请求示例 通过标签过滤带宽包实例 ``` POST https://{cc_endpoint}/v3/{domain_id}/ccaas/bandwidth-packages/filter { "tags" : [ { "key" : "key", "values" : [ "value" ] } ] } ``` #### 响应示例 **状态码：200** 通过标签过滤带宽包实例成功。 ``` { "request_id" : "61126320a1802d5c6444f9d2d76526c2", "bandwidth_packages" : [ { "bandwidth" : 5, "status" : "ACTIVE", "id" : "a3bad42033b84e269e9bbdf67aa8e72b", "name" : "test_bwp_name", "description" : "", "domain_id" : "f87a4b574ba18fbc43fcbdccdcdf48944caa", "created_at" : "2023-09-20T08:37:15Z", "updated_at" : "2023-09-20T08:37:15Z", "project_id" : "2b20c49c4c6d4eefb7b7c7c7c7c7c7c7", "resource_type" : "cloud_connection", "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" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ], "interflow_mode" : "Area" } ], "page_info" : { "next_marker" : "XXX", "previous_marker" : "XXX", "current_count" : 1 } } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 通过标签过滤带宽包实例 ``` 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.*; import java.util.List; import java.util.ArrayList; public class ListBandwidthPackagesByTagsSolution { 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("")) .build(); ListBandwidthPackagesByTagsRequest request = new ListBandwidthPackagesByTagsRequest(); ListBandwidthPackagesByTagsRequestBody body = new ListBandwidthPackagesByTagsRequestBody(); List listTagsValues = new ArrayList<>(); listTagsValues.add("value"); List listbodyTags = new ArrayList<>(); listbodyTags.add( new MultivaluedTag() .withKey("key") .withValues(listTagsValues) ); body.withTags(listbodyTags); request.withBody(body); try { ListBandwidthPackagesByTagsResponse response = client.listBandwidthPackagesByTags(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()); } } } ``` - [Python] 通过标签过滤带宽包实例 ``` # 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("")) \ .build() try: request = ListBandwidthPackagesByTagsRequest() listValuesTags = [ "value" ] listTagsbody = [ MultivaluedTag( key="key", values=listValuesTags ) ] request.body = ListBandwidthPackagesByTagsRequestBody( tags=listTagsbody ) response = client.list_bandwidth_packages_by_tags(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] 通过标签过滤带宽包实例 ``` 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, err := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := cc.CcClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := cc.NewCcClient(hcClient) request := &model.ListBandwidthPackagesByTagsRequest{} var listValuesTags = []string{ "value", } var listTagsbody = []model.MultivaluedTag{ { Key: "key", Values: listValuesTags, }, } request.Body = &model.ListBandwidthPackagesByTagsRequestBody{ Tags: listTagsbody, } response, err := client.ListBandwidthPackagesByTags(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CC/sdk?api=ListBandwidthPackagesByTags&version=v3)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 通过标签过滤带宽包实例成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-cc/ErrorCode.html)。