Deletes a transit router.

Usage notes

Before you delete a transit router, make sure that the following prerequisites are met:

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
Action String Yes DeleteTransitRouter

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

ClientToken String No 02fb3da4-130e-11e9-8e44-001****

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 and cannot exceed 64 characters in length.

DryRun Boolean No false

Specifies whether to only precheck the request. Check items include permissions and the status of the transit router. Valid values:

  • false (default): sends a normal request. If the request passes the precheck, the transit router is deleted.
  • true: sends a request only for precheck. No transit router is deleted after the request passes the precheck. If you use this value, the system checks whether the required parameters are set, and whether the request syntax is valid. If the request fails the precheck, the corresponding error message is returned. If the request passes the precheck, the DryRunOperation error message is returned.
TransitRouterId String Yes tr-uf654ttymmljlvh2x****

The ID of the transit router.

Response parameters

Parameter Type Example Description
RequestId String 6DE3EE92-39C8-4BBD-A3AD-F568D74741BB

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DeleteTransitRouter
&TransitRouterId=tr-uf654ttymmljlvh2x****
&<Common request parameters>

Sample success responses

XML format

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

<DeleteTransitRouterResponse> 
<RequestId>6DE3EE92-39C8-4BBD-A3AD-F568D74741BB</RequestId>
</DeleteTransitRouterResponse>

JSON format

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

{
  "RequestId" : "6DE3EE92-39C8-4BBD-A3AD-F568D74741BB"
}

Error codes

HttpCode Error code Error message Description
400 OperationFailed.DeleteTransitRouter Operation failed because TransitRouterRouteEntry exists The error message returned because the specified transit router cannot be deleted. Route entries are configured for the specified transit router.
400 OperationFailed.DeleteTransitRouter Operation failed because TransitRouterRouteTable exists The error message returned because the specified transit router cannot be deleted. Custom route tables are associated with the transit router.
400 IncorrectStatus.TransitRouterInstance The status of TransitRouter is incorrect. The error message returned because the transit router cannot be deleted in the current state.

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