Updates the maximum bandwidth value of outbound data transfer for a virtual border router (VBR).
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
vpc:UpdateVirtualBorderBandwidth | update |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The region ID of the VBR. You can call the DescribeRegions operation to query the most recent region list. | cn-shanghai |
VirtualBorderRouterId | string | Yes | The ID of the VBR. | vbr-bp15zckdt37pq72**** |
Bandwidth | integer | Yes | The new maximum bandwidth value for the VBR. Unit: Mbit/s. | 2 |
ClientToken | string | No | 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
Examples
Sample success responses
JSON
format
{
"Code": "OK",
"HttpStatusCode": "200",
"Message": "none",
"RequestId": "AA4486A8-B6AE-469E-AB09-820EF8ECFA2B",
"Success": true
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | OperationFailed.Vpconn | The operation is failed because of Vpconn. | You cannot set the Vpconn parameter. |
400 | MissingParam.InstanceId | Missing param of InstanceId. | The InstanceId parameter is not set. |
400 | InvalidInstanceId.NotFound | InstanceId not found. | The InstanceId is set to an invalid value. |
400 | MissingParam.Bandwidth | Missing param of Bandwidth. | The Bandwidth parameter is not set. |
400 | IllegalParam.Bandwidth | Illegal Param of Bandwidth. | The Bandwidth parameter is set to an invalid value. |
400 | MissingParam.regionNo | Missing param of regionNo. | - |
400 | QuotaExceeded.VirtualBorderRouterBandwidth | Quota Exceeded of VirtualBorderRouterBandwidth | The bandwidth of the VBR exceeds the upper limit. |
400 | OperationUnsupported.SetMultiPconnBandwidth | Set Multi PhysicalConnection Bandwidth Unsupported. | Bandwidth for multiple Express Connect circuits is not supported. |
400 | OperationUnsupported.ModifyBandwidth | Modify Sale VirtualBorderRouter Bandwidth Unsupported. | You cannot save the modified bandwidth parameter. |
400 | OperationFailed.PconnTrafficNotEnable | The 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 time | Summary of changes | Operation |
---|---|---|
2023-10-09 | API Description Update. The Error code has changed | View Change Details |
2021-09-27 | The Error code has changed | View Change Details |