Terminate the Virtual Border Router (VBR).

After the API is called, the VBR status will be changed from the Enabled status to the Terminated state.
Note Only the owner of the physical connection to which the VBR is connected can call the API.

Debug

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 TerminateVirtualBorderRouter

The action to perform. Valid value: 

TerminateVirtualBorderRouter

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-bp15zckdt37pq72zvw3

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.

Examples

Request example


http(s)://vpc.aliyuncs.com/?Action=TerminateVirtualBorderRouter
&RegionId=cn-shanghai
&VbrId=vbr-bp15zckdt37pq72zvw3
&<CommonParameters>
Response example
  • XML format

    <TerminateVirtualBorderRouterResponse>
      <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>
    </TerminateVirtualBorderRouterResponse>
    
  • JSON format

    {
    	"RequestId":"0ED8D006-F706-4D23-88ED-E11ED28DCAC0"
    }

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 status of the VBR is invalid.
403 Forbidden.OperationNotAllowedByUser The caller is not allowed to terminate the specified VirtualBorderRouter. You are not allowed to terminate the VBR.

View the error codes of the product