创建一个公网带宽包。公网带宽包是全球加速(GA)的计费与带宽资源载体,创建成功后可绑定到加速实例(标准型或基础型),为其提供公网出口带宽。创建时需指定带宽值、带宽类型、计费方式与购买时长。
参数名称 | 数据类型 | 是否必选 | 参数说明 |
|---|---|---|---|
Action | String | 是 | 接口名称。当前 API 的名称为 CreatePublicBandwidthPackage。 |
Version | String | 是 | 接口版本。当前 API 的版本为 2022-03-01。 |
参数名称 | 数据类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
Bandwidth | Integer | 是 | 公网带宽包的带宽值,单位为 Mbps。取值范围:2~10000。 | 2 |
BandwidthType | String | 是 | 带宽类型,决定带宽的计费与调度模式。取值:
| Advanced |
ChargeType | String | 是 | 公网带宽包的计费方式。取值:
| PREPAY |
Duration | Integer | 是 | 购买时长,单位为月,取值范围 [1, 12]。仅在 ChargeType 为 PREPAY(预付费)时生效,与计费周期配合决定资源到期时间。 | 1 |
RenewType | Integer | 是 | 续费方式,决定预付费资源到期后的处理方式。取值:
| 1 |
ProjectName | String | 否 | 资源所属的项目名称。用于在账号内按项目隔离与归集资源,不传时归入默认项目。 | test-project |
ResourceTags | Object[] | 否 | 为公网带宽包绑定的标签列表。标签用于资源分类与检索,每个标签由键( Key)和值(Value)组成。 |
返回新建公网带宽包的唯一标识及对应的订单号,可用于后续绑定加速实例或查询订单状态。
参数名称 | 数据类型 | 参数说明 | 示例 |
|---|---|---|---|
BandwidthPackageId | String | 新建公网带宽包的唯一标识。后续绑定加速实例、查询、续费或退订带宽包时作为入参。 | gbwp-xxx |
PreorderNumbers | String[] | 本次创建生成的订单号列表。可用于在计费系统中查询订单状态或支付情况。 | Order20230604110420**** |
POST https://open.volcengineapi.com?Action=CreatePublicBandwidthPackage&Version=2022-03-01 { "Bandwidth": 100, "BandwidthType": "Advanced", "ChargeType": "PREPAY", "Duration": 1, "RenewType": 1, "ProjectName": "default", "ResourceTags": [ { "Key": "env", "Value": "production" } ] }
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "CreatePublicBandwidthPackage", "Version": "2022-03-01", "Service": "ga", "Region": "cn-north-1" }, "Result": { "BandwidthPackageId": "bwp-2bxupks6ye3b4****", "PreorderNumbers": [ "Order20230604110420****" ] } }