文档首页/ 弹性公网IP EIP/ API参考/ API/ 带宽加油包/ 查询带宽加油包列表 - ListBandwidthPkg
更新时间：2025-10-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询带宽加油包列表 - 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"
  } ]
}

状态码

状态码

描述

200

GET操作正常返回

错误码

请参见错误码。

父主题： 带宽加油包

相关文档