Modifies the maximum outbound bandwidth of 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
RegionId String Yes cn-shanghai

The region ID of the VBR.

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

VirtualBorderRouterId String Yes vbr-bp15zckdt37pq72****

The ID of the VBR.

Bandwidth Integer Yes 2

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

Action String Yes UpdateVirtualBorderBandwidth

The operation that you want to perform. Set the value to UpdateVirtualBorderBandwidth.

ClientToken String No 02fb3da4-130e-11e9-8e44-0016****

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

You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

Note If you do not set this parameter, the system uses RequestId as ClientToken. RequestId may be different for each API request.

Response parameters

Parameter Type Example Description
Code String 200

The response code.

HttpStatusCode Integer 200

The HTTP status code.

Message String successful

The response message.

RequestId String AA4486A8-B6AE-469E-AB09-820EF8ECFA2B

The ID of the request.

Success Boolean true

Indicates whether the maximum bandwidth is updated. Valid values:

  • true
  • false

Examples

Sample requests

http(s)://[Endpoint]/?RegionId=cn-shanghai
&VirtualBorderRouterId=vbr-bp15zckdt37pq72****
&Bandwidth=2
&Action=UpdateVirtualBorderBandwidth
&ClientToken=02fb3da4-130e-11e9-8e44-0016****
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateVirtualBorderBandwidthResponse>
    <Code>200</Code>
    <HttpStatusCode>200</HttpStatusCode>
    <Message>successful</Message>
    <RequestId>AA4486A8-B6AE-469E-AB09-820EF8ECFA2B</RequestId>
    <Success>true</Success>
</UpdateVirtualBorderBandwidthResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HttpCode Error code Error message Description
400 OperationFailed.PconnTrafficNotEnable The operation is failed because of PconnTrafficNotEnable. The error message returned because billing for outbound data transfer is disabled.

For a list of error codes, visit the API Error Center.