创建公网带宽包,并设置带宽值、带宽类型和计费配置。创建成功后可绑定到包年包月的标准型或基础型加速器,为其提供公网数据传输带宽。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | CreatePublicBandwidthPackage | 要执行的操作,取值: CreatePublicBandwidthPackage。 |
Version | String | 是 | 2022-03-01 | API 的版本,取值: 2022-03-01。 |
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Bandwidth | Integer | 是 | 100 | 指定公网带宽包的带宽值,单位为 Mbps,取值范围为 [2, 10000]。 |
BandwidthType | String | 是 | Advanced | 指定公网带宽包的带宽类型。取值:
|
ChargeType | String | 是 | PREPAY | 公网带宽包的计费方式。取值:
|
Duration | Integer | 是 | 1 | 指定包年包月公网带宽包的订阅时长,单位为月,取值范围为 [1, 12]。仅当 ChargeType 为 PREPAY(包年包月)时生效。 |
RenewType | Integer | 否 | 1 | 指定包年包月公网带宽包的续费方式。取值:
|
ProjectName | String | 否 | test-project | 指定公网带宽包所属的项目。项目是火山引擎通用的资源管理工具,用于对账号下的云资源进行分组管理与权限隔离。若不指定,则归属默认项目 default。 |
ResourceTags | Object[] | 否 | 为公网带宽包设置自定义标签,每个标签为一个键值对。 单个公网带宽包最多可关联 10 个标签。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
BandwidthPackageId | String | gbwp-RTw5UPU3k2n4mfDYsC**** | 新建公网带宽包的 ID。 |
PreorderNumbers | String[] | ["Order20230604110420****"] | 本次创建生成的订单号列表。可用于在计费系统中查询订单状态或支付情况。 |
POST https://ga.volcengine-api.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": "202306041104201234100232280022D31", "Action": "CreatePublicBandwidthPackage", "Version": "2022-03-01", "Service": "ga", "Region": "cn-beijing" }, "Result": { "BandwidthPackageId": "gbwp-RTw5UPU3k2n4mfDYsC****", "PreorderNumbers": [ "Order20230604110420****" ] } }
本接口无专用错误码。公共错误码请参见公共错误码。