# 查询大区互通类型的带宽包资源规格列表 - ListAreaBandwidthPackageSpecifications #### 功能介绍 查询大区互通类型的带宽包资源规格列表。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CC/doc?api=ListAreaBandwidthPackageSpecifications&version=v3)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-cc/cc_02_0002.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v3/{domain_id}/ccaas/bandwidth-packages/area-specifications 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | domain_id | 是 | String | 用户的账号ID，即租户ID，用于标识资源所属的华为云账号。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | - 参数解释：每页返回的个数，用于控制分页查询返回的记录数量。 - 约束限制：不涉及。 - 取值范围：1\~2000。 - 默认取值：2000。 | | offset | 否 | Integer | （索引位置，偏移量）， 从offset指定的下一条数据开始查询。 查询第一页数据时，不需要传入此参数，查询后续页码数据时，将查询前一页数据时响应体中的值带入此参数（action为count时无此参数） 从第一条数据偏移offset条数据后开始查询，如果action为filter默认为0（偏移0条数据，表示从第一条数据开始查询）,必须为数字，不能为负数。 | | local_area_id | 否 | Array of strings | 根据本端大区ID过滤带宽包资源规格列表。云连接支持的大区有： - Chinese-Mainland: 中国大陆 - Asia-Pacific: 亚太 - Africa: 非洲 - Western-Latin-America: 拉美西 - Eastern-Latin-America: 拉美东 - Northern-Latin-America: 拉美北 | | remote_area_id | 否 | Array of strings | 根据对端大区ID过滤带宽包资源规格列表。云连接支持的大区有： - Chinese-Mainland: 中国大陆 - Asia-Pacific: 亚太 - Africa: 非洲 - Western-Latin-America: 拉美西 - Eastern-Latin-America: 拉美东 - Northern-Latin-America: 拉美北 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 否 | String | 用户Token，即用户的认证令牌，用于验证用户身份和权限。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | request_id | String | 请求ID。 | | page_info | [PageInfo] object | 分页查询页的信息。 | | area_specifications | Array of [AreaBandwidthPackageSpecification] objects | 大区带宽包规格列表。 | 表5PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | next_marker | String | 向后分页标识符。 | | previous_marker | String | 向前分页标识符。 | | current_count | Integer | 当前列表中资源数量。 | 表6AreaBandwidthPackageSpecification | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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: 拉美北 | | id | String | 互通大区带宽包的规格ID。 | | spec_codes | Array of [SpecificationCodeInfo] objects | 带宽包产品规格列表。 | 表7SpecificationCodeInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | spec_code | String | - 参数解释：带宽包实例的规格编码，用于标识带宽包的产品规格类型。 - 约束限制：长度范围为0\~32个字符，必须为有效的规格编码。 - 取值范围：不涉及。 - 默认取值：不涉及。 - 获取方式：通过查询带宽包规格接口获取可用的规格编码。 | | billing_mode | Integer | 带宽包实例在大陆站或国际站的计费方式，有效值： - 1：大陆站包周期。 - 2：国际站包周期。 - 3：大陆站按需计费。 - 4：国际站按需计费。 - 5：大陆站按95方式计费。 - 6：国际站按95方式计费。 - 7：大陆站按日95方式计费。 - 8：国际站按日95方式计费。 | | max_bandwidth | Long | 最大带宽。 | | min_bandwidth | Long | 最小带宽。 | #### 请求示例 查询带宽包资源规格列表。 ``` GET https://{cc_endpoint}/v3/{domain_id}/ccaas/bandwidth-packages/area-specifications ``` #### 响应示例 **状态码：200** 查询带宽包资源规格列表成功。 ``` { "request_id" : "a3bad42033b84e269e9bbdf67aa8e72b", "area_specifications" : [ { "id" : "a3bad42033b84e269e9bbdf67aa8e72b", "local_area_id" : "Chinese-Mainland", "remote_area_id" : "Chinese-Mainland", "spec_codes" : [ { "billing_mode" : 1, "spec_code" : "bandwidth.abctoabc", "max_bandwidth" : 100, "min_bandwidth" : 0 } ] } ], "page_info" : { "next_marker" : "a3bad42033b84e269e9bbdf67aa8e72b", "previous_marker" : "a3bad42033b84e269e9bbdf67aa8e72b", "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.*; public class ListAreaBandwidthPackageSpecificationsSolution { 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(); ListAreaBandwidthPackageSpecificationsRequest request = new ListAreaBandwidthPackageSpecificationsRequest(); try { ListAreaBandwidthPackageSpecificationsResponse response = client.listAreaBandwidthPackageSpecifications(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 = ListAreaBandwidthPackageSpecificationsRequest() response = client.list_area_bandwidth_package_specifications(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.ListAreaBandwidthPackageSpecificationsRequest{} response, err := client.ListAreaBandwidthPackageSpecifications(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=ListAreaBandwidthPackageSpecifications&version=v3)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询带宽包资源规格列表成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-cc/ErrorCode.html)。