更新公网带宽包的目标带宽或所属项目。带宽值变更可能产生订单和费用,响应会说明本次变更是否需要支付及对应订单号。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | UpdatePublicBandwidthPackage | 要执行的操作,取值: UpdatePublicBandwidthPackage。 |
Version | String | 是 | 2022-03-01 | API 的版本,取值: 2022-03-01。 |
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
BandwidthPackageId | String | 是 | gbwp-RTw5UPU3k2n4mfDYsC**** | 指定待更新的公网带宽包 ID。可通过调用 ListPublicBandwidthPackages 接口获取公网带宽包 ID。 |
Volume | Integer | 否 | 2 | 设置公网带宽包的目标带宽,单位为 Mbps。取值范围为 [2, 10000]。 |
ProjectName | String | 否 | default | 指定公网带宽包所属的项目。项目是火山引擎通用的资源管理工具,用于对账号下的云资源进行分组管理与权限隔离。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
IsNeedPay | Boolean | true | 本次变更是否需要支付。取值:
|
OrderId | String | Order20230604110420**** | 本次变更生成的订单号。 |
POST https://ga.volcengine-api.com?Action=UpdatePublicBandwidthPackage&Version=2022-03-01 { "BandwidthPackageId": "gbwp-RTw5UPU3k2n4mfDYsC****", "Volume": 200, "ProjectName": "default" }
{ "ResponseMetadata": { "RequestId": "202306041104201234100232280022D31", "Action": "UpdatePublicBandwidthPackage", "Version": "2022-03-01", "Service": "ga", "Region": "cn-beijing" }, "Result": { "IsNeedPay": true, "OrderId": "Order20230604110420****" } }
本接口无专用错误码。公共错误码请参见公共错误码。