All Products
Search
Document Center

Virtual Private Cloud:UpdateVirtualBorderBandwidth

Last Updated:Aug 29, 2024

Updates the maximum bandwidth value of outbound data transfer for a virtual border router (VBR).

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the VBR.

You can call the DescribeRegions operation to query the most recent region list.

cn-shanghai
VirtualBorderRouterIdstringYes

The ID of the VBR.

vbr-bp15zckdt37pq72****
BandwidthintegerYes

The new maximum bandwidth value for the VBR. Unit: Mbit/s.

2
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.

Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
02fb3da4-130e-11e9-8e44-0016****

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The error code.

OK
HttpStatusCodestring

The HTTP status code.

200
Messagestring

The returned message.

none
RequestIdstring

The request ID.

AA4486A8-B6AE-469E-AB09-820EF8ECFA2B
Successboolean

Indicates whether the operation is successful. Valid values:

  • true
  • false
true

Examples

Sample success responses

JSONformat

{
  "Code": "OK",
  "HttpStatusCode": "200",
  "Message": "none",
  "RequestId": "AA4486A8-B6AE-469E-AB09-820EF8ECFA2B",
  "Success": true
}

Error codes

HTTP status codeError codeError messageDescription
400OperationFailed.VpconnThe operation is failed because of Vpconn.You cannot set the Vpconn parameter.
400MissingParam.InstanceIdMissing param of InstanceId.The InstanceId parameter is not set.
400InvalidInstanceId.NotFoundInstanceId not found.The InstanceId is set to an invalid value.
400MissingParam.BandwidthMissing param of Bandwidth.The Bandwidth parameter is not set.
400IllegalParam.BandwidthIllegal Param of Bandwidth.The Bandwidth parameter is set to an invalid value.
400MissingParam.regionNoMissing param of regionNo.-
400QuotaExceeded.VirtualBorderRouterBandwidthQuota Exceeded of VirtualBorderRouterBandwidthThe bandwidth of the VBR exceeds the upper limit.
400OperationUnsupported.SetMultiPconnBandwidthSet Multi PhysicalConnection Bandwidth Unsupported.Bandwidth for multiple Express Connect circuits is not supported.
400OperationUnsupported.ModifyBandwidthModify Sale VirtualBorderRouter Bandwidth Unsupported.You cannot save the modified bandwidth parameter.
400OperationFailed.PconnTrafficNotEnableThe operation is failed because of PconnTrafficNotEnable.Billing for outbound data transfer is disabled.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-10-09API Description Update. The Error code has changedView Change Details
2021-09-27The Error code has changedView Change Details