Terminates a Virtual Border Router (VBR).
After this API is called, the VBR changes from the Enabled state to the Terminated state. After the termination is completed, the VBR status changes to Terminated.
Debug
Use OpenAPI Explorer to perform debug operations and generate SDK code examples.
Request parameters
Parameter | Type | Required? | Example value | Description |
---|---|---|---|---|
Action | String | Yes | TerminateVirtualBorderRouter |
The name of this action. Value: TerminateVirtualBorderRouter |
RegionId | String | Yes | cn-shanghai |
The ID of the region to which the VBR belongs. To query the region ID, call DescribeRegions. |
VbrId | String | Yes | vbr-bp15zckdt37pq72**** |
The ID of the VBR to be terminated. |
ClientToken | String | No | 02fb3da4-130e-11e9-8e44-0016e04115b |
Optional. The client token. It is used to guarantee the idempotence of the request. The value of this parameter is generated by the client and is unique among different requests. It can be 1 to 64 ASCII characters in length. |
Response parameters
Parameter | Type | Example value | Description |
---|---|---|---|
RequestId | String | 4EC47282-1B74-4534-BD0E-403F3EE64CAF |
The request ID. |
Examples
Request example
http(s)://[Endpoint]/? Action=TerminateVirtualBorderRouter
&RegionId=cn-shanghai
&VbrId=vbr-bp15zckdt37pq72****
&<CommonParameters>
Response examples
XML
format
<TerminateVirtualBorderRouterResponse>
<RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>
</TerminateVirtualBorderRouterResponse>
JSON
format
{
"RequestId":"0ED8D006-F706-4D23-88ED-E11ED28DCAC0"
}
Errors
HTTP status 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 does not permit this operation. |
403 | Forbidden.OperationNotAllowedByUser | The caller is not allowed to terminate the specified VirtualBorderRouter. | You are not allowed to terminate the VBR. |
For a list of error codes, visit the API Error Center.