Terminates a virtual border router (VBR).

Usage

After the operation is called, the VBR changes from the Enabled state to the Terminating state. After the VBR is terminated, it enters the Terminated state.

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

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.

VbrId String Yes vbr-bp15zckdt37pq72****

The ID of the VBR.

Action String Yes TerminateVirtualBorderRouter

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

ClientToken String No 123e4567-e89b-12d3-a456-426655440000

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.

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

Response parameters

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

The ID of the request.

Example

Sample requests

http(s)://[Endpoint]/?RegionId=cn-shanghai
&VbrId=vbr-bp15zckdt37pq72****
&Action=TerminateVirtualBorderRouter
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&Common request parameters

Sample success responses

XML format 

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

<TerminateVirtualBorderRouterResponse>
    <RequestId>4EC47282-1B74-4534-BD0E-403F3EE64CAF</RequestId>
</TerminateVirtualBorderRouterResponse>

JSON format 

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

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

Error codes

HttpCode Error code Error message Description
400 InvalidOperation.OperationNotAllowedInState The specified VirutalBorderRouter is in invalid state. The error message returned because 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 error message returned because you do not have the permissions to terminate the VBR.
404 InvalidVbrId.NotFound The specified VirutalBorderRouter is not found. The error message returned because the specified VBR does not exist. Check whether the specified VBR is valid.

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