# 查询带宽加油包列表 - ListBandwidthPkg #### 功能介绍 查询带宽加油包列表信息 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/EIP/doc?api=ListBandwidthPkg&version=v2)中调试该接口，支持自动认证鉴权。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-eip/eip_apipermission_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | eip:bandwidthPkgs:list | List | bandwidthPkg \* | - | vpc:bandwidths:get | - | #### URI GET /v2/{project_id}/bandwidthpkgs 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID [参见获取项目ID](https://support.huaweicloud.com/api-eip/eip_api06_0004.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | bandwidthId | 否 | String | **参数解释：** 取值为带宽ID，根据带宽ID过滤加油包列表。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 最大长度36。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | bandwidthpkgs | Array of [BandwidthPkgResp] objects | **参数解释：** bandwidthpkg对象列表。 **取值范围：** 不涉及。 | | bandwidthpkgs_links | Array of [BandwidthPkgPage] objects | **参数解释：** 翻页展示。 **取值范围：** 不涉及。 | 表4BandwidthPkgResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | resourceId | String | **参数解释：** 加油包ID。 **取值范围：** 不涉及。 | | resourceName | String | **参数解释：** 加油包名称。 **取值范围：** 1-64，支持数字、字母、中文、_（下划线）、-（中划线）。 | | processedTime | String | **参数解释：** 资源创建时间，UTC时间格式：2016-03-28T00:00:00Z。 **取值范围：** 不涉及。 | | bandwidthId | String | **参数解释：** 加油包绑定的原带宽ID。 **取值范围：** 不涉及。 | | pkgSize | Integer | **参数解释：** 加油包的大小，即在原始带宽之上提升的带宽大小。 **取值范围：** 说明： 1M，pkgSize+原始带宽大小 \< 云服务带宽接口限制的带宽上限 | | tenantId | String | **参数解释：** 租户id。 **取值范围：** 不涉及。 | | billingInfo | String | **参数解释：** 加油包订单相关信息格式：非空时值为''''orderId:productId''''。 **取值范围：** 不涉及。 | | startTime | String | **参数解释：** 加油包起始生效时间，UTC时间格式：2016-03-28T00:00:00Z。 **取值范围：** startTime \>= 服务处理请求的时间。 | | endTime | String | **参数解释：** 加油包结束时间UTC时间格式：2016-03-28T00:00:00Z。 **取值范围：** startTime \< endTime。 | | status | String | **参数解释：** 加油包资源状态。 **取值范围：** - pending 处理中。 - active 生效中。 - completed 已耗尽。 - error 异常。 | 表5BandwidthPkgPage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | href | String | **参数解释：** - 链接。 **取值范围：** 不涉及。 | | rel | String | **参数解释：** - 翻页标志。 **取值范围：** 不涉及。 | #### 请求示例 ``` GET https://{Endpoint}/v2/{project_id}/bandwidthpkgs ``` #### 响应示例 **状态码：200** ``` { "bandwidthpkgs" : [ { "resourceId" : "0003cb59-eaa4-4c05-85bd-4b4cc806992c", "resourceName" : "bandwidthpkg-test", "pkgSize" : 5, "processedTime" : "2018-10-13T20:21:17Z", "bandwidthId" : "6c50f312-2eab-4f08-9da2-b41b0801d8be", "tenantId" : "e136ddf186a84dff9c5d5364de79f4e4", "billingInfo" : "CS1810091953KI13V:edcb94a885a84ed3a3fdf8ea4d2741da", "startTime" : "2018-10-24T21:02:17Z", "endTime" : "2018-10-28T21:02:17Z", "status" : "pending" } ], "bandwidthpkgs_links" : [ { "href" : "https://vpc.br-iaas-test.mycloud.com:443/v2/0605767f6f00d5762ff9c001c70e7359/bandwidthpkgs?limit=2000&marker=4fc74637-753f-46cb-af8c-b58528887a79&page_reverse=true", "rel" : "previous" } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; 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.eip.v2.region.EipRegion; import com.huaweicloud.sdk.eip.v2.*; import com.huaweicloud.sdk.eip.v2.model.*; public class ListBandwidthPkgSolution { 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); EipClient client = EipClient.newBuilder() .withCredential(auth) .withRegion(EipRegion.valueOf("")) .build(); ListBandwidthPkgRequest request = new ListBandwidthPkgRequest(); try { ListBandwidthPkgResponse response = client.listBandwidthPkg(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 BasicCredentials from huaweicloudsdkeip.v2.region.eip_region import EipRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkeip.v2 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"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = EipClient.new_builder() \ .with_credentials(credentials) \ .with_region(EipRegion.value_of("")) \ .build() try: request = ListBandwidthPkgRequest() response = client.list_bandwidth_pkg(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/basic" eip "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v2/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") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := eip.EipClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := eip.NewEipClient(hcClient) request := &model.ListBandwidthPkgRequest{} response, err := client.ListBandwidthPkg(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/EIP/sdk?api=ListBandwidthPkg&version=v2)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | GET操作正常返回 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-eip/ErrorCode.html)。