Recover a terminated Virtual Border Router (VBR).

After the API is called, the VBR status will immediately change from the Terminated state to the Recovering state. Then, when the operation is completed, the status of the VBR is Enabled.

Note the following before recovering a VBR:

  • Only the owner of the physical connection can call this API.

  • The physical connection that the VBR connects to must be in the Enabled state.


By using API Explorer, you can easily debug APIs, automatically generate SDK code examples, and quickly search for APIs. API Explorer can help reduce possible difficulty with using cloud APIs. We recommend that you use API Explorer.

Request parameters

Parameter Type Required? Example value Description
Action String Yes RecoverVirtualBorderRouter

The action to perform. Valid value:


RegionId String Yes cn-shanghai

The ID of the region where the VBR is located.

You can obtain the region ID by calling the DescribeRegions API.

VbrId String Yes vbr-bp1lhl0taikrteen80

The ID of the VBR.

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

A client token used to guarantee the idempotence of requests.

This parameter value is generated by the client and is guaranteed to be unique among different requests. The maximum length is 64 ASCII characters.

Response parameters

Parameter Type Example value Description
RequestId String 4EC47282-1B74-4534-BD0E-403F3EE64CAF The ID of the request.


Request example

Response example
  • XML format

  • JSON format


Error codes

HTTP 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 current status of the VBR does not support 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 VBR.

View the error codes of the product