All Products
Search
Document Center

Express Connect:TerminateVirtualBorderRouter

Last Updated:Aug 28, 2026

Terminates a virtual border router (VBR).

Operation description

When you call this operation, the VBR transitions from the active state to the terminating state, and then to the terminated state after the termination is complete.

Note

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

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 ensures 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.

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 elements

Element

Type

Description

Example

object

The request ID.

RequestId

string

The request ID.

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

Examples

Success response

JSON format

{
  "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.
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.
404 InvalidVbrId.NotFound The specified VirutalBorderRouter is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.