All Products
Search
Document Center

Virtual Private Cloud:RecoverVirtualBorderRouter

Last Updated:Mar 04, 2024

Enables a disabled virtual border router (VBR).

Operation description

After you call this operation, the VBR changes from the terminated state to the recovering state. After the operation is performed, the VBR enters the active state.

When you call this operation, take note of the following items:

  • Only the owner of the Express Connect circuit can call this operation.
  • The Express Connect circuit to which the VBR connects must be in the Enabled state.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:RecoverVirtualBorderRouterWrite
  • VirtualBorderRouter
    acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#VirtualBorderRouterId}
    none
none

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
VbrIdstringYes

The ID of the VBR.

vbr-bp1lhl0taikrte****
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 and cannot exceed 64 characters in length.

02fb3da4-130e-11e9-8e44-0016e04115b

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

4EC47282-1B74-4534-BD0E-403F3EE64CAF

Examples

Sample success responses

JSONformat

{
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidOperation.OperationNotAllowedInStateThe specified VirutalBorderRouter is in invalid stateThe status of the VBR interface does not support this operation.
400OperationFailed.VlanIdAlreadyInUseThe specifed vlanId has been used.The VLAN ID is in use.
400OperationFailed.PconnTrafficNotEnableThe operation is failed because of PconnTrafficNotEnable.Billing for outbound data transfer is disabled.
403Forbidden.OperationRecoverNotAllowedByUserThe caller is not allowed to recover the specified VirtualBorderRouter.The caller is not allowed to recover the specified VirtualBorderRouter.
404InvalidRegionId.NotFoundThe RegionId provided does not exist in our records.The RegionId parameter is set to an invalid value. Specify a valid value and try again.
404InvalidVbrId.NotFoundThe specified VirutalBorderRouter is not found.The VBR does not exist. Check the VBR ID.

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

Change history

Change timeSummary of changesOperation
No change history