文档中心

全球加速

公网带宽包管理

查询公网带宽包列表 ListPublicBandwidthPackages

分页查询当前账号下的公网带宽包列表。支持按带宽包 ID、状态、关联的加速器、带宽类型、所属项目和标签等条件过滤，返回每个带宽包的规格、计费、状态、时间与关联资源信息。

请求说明

请求方式：POST
请求地址：https://ga.volcengine-api.com?Action=ListPublicBandwidthPackages&Version=2022-03-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必填	示例值	描述
Action	String	是	`ListPublicBandwidthPackages`	要执行的操作，取值：`ListPublicBandwidthPackages`。
Version	String	是	`2022-03-01`	API 的版本，取值：`2022-03-01`。

Body

参数	类型	是否必填	示例值	描述
AcceleratorId	String	否	`accinstance-YfiSM6k5BspFcC4BaG****`	按关联的加速器 ID 过滤，仅返回已绑定该加速器的公网带宽包。
BandwidthPackageId	String	否	`gbwp-RTw5UPU3k2n4mfDYsC****`	按公网带宽包 ID 精确过滤，仅返回与该 ID 匹配的公网带宽包。
BandwidthType	String	否	`Advanced`	按公网带宽类型过滤。取值： `Standard`：标准公网带宽。 `Advanced`：精品公网带宽。
State	String	否	`bound`	按公网带宽包状态过滤。取值： `bound`：已绑定。 `unbound`：未绑定。 `deploy`：部署中。 `expired`：已过期。 `overdue`：欠费。 `frozen`：冻结。
PageSize	Integer	否	`10`	分页查询时每页返回的最大条目数。默认值为 `10`，最大值为 `100`。
PageNum	Integer	否	`1`	分页查询的页码。默认值为 `1`。
ProjectName	String	否	`default`	按所属项目名称过滤，仅返回归属该项目的带宽包。项目是火山引擎通用的资源管理工具，用于对账号下的云资源进行分组管理与权限隔离。
ResourceTagFilter	Object	否		按标签过滤带宽包。可指定一组标签键值及匹配方式，仅返回满足标签条件的带宽包。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
PageNum	Integer	`1`	本次返回结果的页码。
PageSize	Integer	`10`	本次返回的每页条目数。
TotalCount	Integer	`100`	符合过滤条件的公网带宽包总数。
PublicBandwidthPackages	Object[]		符合过滤条件的公网带宽包列表，每个元素为一个带宽包的详细信息。

请求示例

POST https://ga.volcengine-api.com?Action=ListPublicBandwidthPackages&Version=2022-03-01
{
  "AcceleratorId": "accinstance-YfiSM6k5BspFcC4BaG****",
  "BandwidthPackageId": "gbwp-RTw5UPU3k2n4mfDYsC****",
  "BandwidthType": "Advanced",
  "State": "bound",
  "PageSize": 10,
  "PageNum": 1,
  "ProjectName": "default"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241113115749012050116128C399C7",
    "Action": "ListPublicBandwidthPackages",
    "Version": "2022-03-01",
    "Service": "ga",
    "Region": "cn-beijing"
  },
  "Result": {
    "PageNum": 1,
    "PageSize": 10,
    "TotalCount": 10,
    "PublicBandwidthPackages": [
      {
        "AcceleratorIDs": [
          "accinstance-YfiSM6k5BspFcC4BaG****"
        ],
        "AccountID": "210005XXXX",
        "Bandwidth": 76,
        "BandwidthType": "Advanced",
        "BeginTime": 1717127658,
        "BillingType": "ByBandwidthPrePay",
        "ChargeType": "PREPAY",
        "CreateTime": 1717127658,
        "ExpiredTime": 1719719658,
        "ID": "gbwp-RTw5UPU3k2n4mfDYsC****",
        "Name": "public-bandwidth-package",
        "RenewType": 1,
        "State": "bound",
        "ProjectName": "default",
        "ResourceTags": [
          {
            "Key": "Mw",
            "Value": "5RRE05gdvt"
          }
        ],
        "CreateTimeStr": "2024-05-31T03:54:18Z"
      }
    ]
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码。

状态码	错误码	错误信息	说明
400	GAInnerError	内部错误, 请重试。	服务内部错误，请稍后重试。

最近更新时间：2026.09.23 16:20:54

这个页面对您有帮助吗？

有用

无用

全球加速

请求说明 #

请求参数 #

Query #

Body #

返回参数 #

请求示例 #

返回示例 #

错误码 #