Recovers a Virtual Border Router (VBR) that is terminated.

After the API is called, the VBR status changes from Terminated to Recovering. When the recovering is completed, the status of the VBR changes to Enabled.

Note the following before you recover a VBR:

  • Only the owner of the physical connection can call this API.
  • The physical connection to which the VBR belongs must be in the Enabled state.


Use OpenAPI Explorer to perform debug operations and generate SDK code examples.

Request parameters

Parameter Type Required? Example value Description
Action String Yes RecoverVirtualBorderRouter

The name of this action.

Value: RecoverVirtualBorderRouter

RegionId String Yes cn-shanghai

The ID of the region to which the VBR belongs.

To query the region ID, call DescribeRegions.

VbrId String Yes vbr-bp1lhl0taikrte****

The ID of the VBR.

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

Optional. The client token. It is used to guarantee the idempotence of the request.

The value of this parameter is generated by the client and is unique among different requests. It can contain up to 64 ASCII characters.

Response parameters

Parameter Type Example value Description
RequestId String 4EC47282-1B74-4534-BD0E-403F3EE64CAF

The request ID.


Request example

http(s)://[Endpoint]/? Action=RecoverVirtualBorderRouter

Response examples

XML format


JSON format



HTTP status code Error code Error message Description
404 InvalidVbrId.NotFound The specified VirutalBorderRouter is not found. The specified VBR does not exist.
400 InvalidOperation.OperationNotAllowedInState The specified VirutalBorderRouter is in invalid state The status of the VBR interface does not alllow this operation.
400 OperationFailed.VlanIdAlreadyInUse The specifed vlanId has been used. The specified VLAN is already occupied.
403 Forbidden.OperationNotAllowedByUser The caller is not allowed to recover the specified VirtualBorderRouter. You are not allowed to recover the specified VBR.

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