查询带宽包列表ListBandwidthPackages--全球加速-火山引擎

文档中心

立即注册

导航

查询带宽包列表ListBandwidthPackages

最近更新时间：2024.09.30 11:57:26首次发布时间：2024.09.30 11:57:26

本接口用于查询带宽包列表(包括公网带宽包和跨域带宽包)。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=ListBandwidthPackages&Version=2022-03-01

请求参数

Query

参数名称	数据类型	是否必选	参数说明
Action	String	是	接口名称。当前 API 的名称为 `ListBandwidthPackages`。
Version	String	是	接口版本。当前 API 的版本为 `2022-03-01`。

Body

参数名称	数据类型	是否必选	参数说明	示例
AcceleratorId	String	否	加速器的ID。	`accinstance-xxx`
BandwidthPackageId	String	否	带宽包的ID。	`gbwp-xxx`
BandwidthType	String	是	带宽包类型，默认为跨域带宽包，支持取值： CDB：跨域带宽包 WAN：公网带宽包	`CDB`
State	String	否	带宽包状态跨域带宽包状态，支持取值： active：运行中 reclaimed：已退订 overdue：欠费 frozen：已冻结 unbound：未绑定 deploy：配置中公网带宽包状态，支持取值： bound：已绑定 expired：已过期 unbound：未绑定 deploy：配置中	`active`
PageNumber	Integer	否	列表的页码，默认值为1。	`1`
PageSize	Integer	否	分页查询时每页的行数。默认值：10。最大值：1000。	`10`

返回参数

参数名称	数据类型	参数说明	示例
CrossDomainBandwidthPackages	Object[]	跨域带宽包列表。	`-`
WANBandwidthPackages	Object[]	公网带宽包列表	`-`
PageNumber	Integer	列表的页码。	`1`
PageSize	Integer	分页查询时每页的行数。	`10`
TotalCount	Integer	列表条目数。	`1`

请求示例

POST https://open.volcengineapi.com?Action=ListBandwidthPackages&Version=2022-03-01
{
  "BandwidthType": "CDB",
  "PageNumber": 1,
  "PageSize": 10
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240927160042991AA2FA8E8931049E70",
        "Action": "ListBandwidthPackages",
        "Version": "2022-03-01",
        "Service": "ga",
        "Region": "cn-north-1"
    },
    "Result": {
        "TotalCount": 1,
        "PageSize": 10,
        "PageNumber": 1,
        "CrossDomainBandwidthPackages": [
            {
                "Id": "crb-xxx",
                "CreateTime": 1721936987,
                "ExpiredTime": 1724687999,
                "ActivatedTime": 1721937034,
                "Name": "",
                "State": "active",
                "BillingType": "ByBandwidthPrePay",
                "ChargeType": "PREPAY",
                "Desc": "",
                "AccountID": "2100055193",
                "EndpointA": "China-mainland",
                "EndpointB": "HK",
                "Bandwidth": 2,
                "AcceleratorId": "accinstance-xxx",
                "Isp": "ChinaTelecom",
                "RenewType": 1
            }
        ]
    }
}