TerminateVirtualBorderRouter - Virtual Private Cloud - Alibaba Cloud Documentation Center

Terminates a virtual border router (VBR).

Operation description

After you call this operation, the VBR enters the terminating state from the active state. After the VBR is terminated, the VBR enters the terminated state.

Note Only the owner of an Express Connect circuit can call this operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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:TerminateVirtualBorderRouter	update	VirtualBorderRouter acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#VirtualBorderRouterId}	none	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
VbrId	string	Yes	The ID of the VBR.	vbr-bp15zckdt37pq72****
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 client 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.	123e4567-e89b-12d3-a456-426655440000

Response parameters

Parameter	Type	Description	Example
	object	The request ID.
RequestId	string	The request ID.	4EC47282-1B74-4534-BD0E-403F3EE64CAF

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidOperation.OperationNotAllowedInState	The specified VirutalBorderRouter is in invalid state.	The specified VBR is in an invalid state. Check the status of the VBR.
403	Forbidden.OperationTerminateNotAllowedByUser	The caller is not allowed to terminate the specified VirtualBorderRouter.	The caller is not allowed to terminate the specified VirtualBorderRouter.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	The RegionId parameter is set to an invalid value. Specify a valid value and try again.
404	InvalidVbrId.NotFound	The 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 time	Summary of changes	Operation
2024-06-26	API Description Update. The Error code has changed	View Change Details