文档首页/ 弹性公网IP EIP/ API参考/ API/ 带宽加油包/ 查询带宽加油包列表 - ListBandwidthPkg
更新时间:2025-12-31 GMT+08:00
分享

查询带宽加油包列表 - ListBandwidthPkg

功能介绍

查询带宽加油包列表信息。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    eip:bandwidthPkgs:list

    List

    bandwidthPkg *

    -

    vpc:bandwidths:get

    -

URI

GET /v2/{project_id}/bandwidthpkgs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取项目ID请参见获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

bandwidthId

String

  • 功能说明:取值为带宽ID,根据带宽ID过滤加油包列表

最大长度:36

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

bandwidthpkgs

Array of BandwidthPkgResp objects

bandwidthpkg对象列表

bandwidthpkgs_links

Array of BandwidthPkgPage objects

翻页展示

表4 BandwidthPkgResp

参数

参数类型

描述

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 异常

表5 BandwidthPkgPage

参数

参数类型

描述

href

String

  • 链接

rel

String

  • 翻页标志

请求示例

GET https://{Endpoint}/v2/{project_id}/bandwidthpkgs

响应示例

状态码:200

GET操作正常返回

{
  "bandwidthpkgs" : [ {
    "resourceId" : "0003cb59-eaa4-4c05-85bd-4b4cc806992c",
    "resourceName" : "bandwidthpkg-test",
    "pkgSize" : "5",
    "processedTime" : "2018-10-13 20:21:17.465126",
    "bandwidthId" : "6c50f312-2eab-4f08-9da2-b41b0801d8be",
    "tenantId" : "e136ddf186a84dff9c5d5364de79f4e4",
    "billingInfo" : "CS1810091953KI13V:edcb94a885a84ed3a3fdf8ea4d2741da",
    "startTime" : "2018-10-24 21:2:17.465126",
    "endTime" : "2018-10-28 21:2:17.465126",
    "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代码示例如下。

 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
46
47
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("<YOUR REGION>"))
                .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());
        }
    }
}
 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
# 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("<YOUR REGION>")) \
        .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)
 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
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := eip.NewEipClient(
        eip.EipClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListBandwidthPkgRequest{}
	response, err := client.ListBandwidthPkg(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

GET操作正常返回

错误码

请参见错误码

相关文档