Deletes a static route for an Enterprise Edition transit router.

Description

Before you call this operation, take note of the following items:

  • If TransitRouterRouteEntryId is set, you must not specify TransitRouterRouteTableId or TransitRouterRouteEntryDestinationCidrBlock. Otherwise, parameter conflicts will occur.
  • If TransitRouterRouteEntryId is not set, you must specify the following parameters based on the type of the next hop:
    • To delete a black hole route, you must specify TransitRouterRouteTableId, TransitRouterRouteEntryDestinationCidrBlock, and TransitRouterRouteEntryNextHopType.
    • If the route that you want to delete is not a black hole route, you must specify TransitRouterRouteTableId, TransitRouterRouteEntryDestinationCidrBlock, TransitRouterRouteEntryNextHopType, and TransitRouterRouteEntryNextHopId.

Limits

You can call this operation to delete only static routes. Automatically learned routes are not supported. You can call the ListTransitRouterRouteEntries operation to query route types.

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 No DeleteTransitRouterRouteEntry

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

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 a token, but you must ensure 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 specified instances. Valid values:

  • false (default): sends a normal request. If the request passes the precheck, the route is deleted.
  • true: sends a request for precheck only. The route is not deleted after the request passes the precheck. If you select this option, the system checks whether the required parameters are set, and whether the request syntax is valid. If the request fails to pass the precheck, the system returns an error. If the request passes the precheck, the system returns the ID of the request.
TransitRouterRouteEntryId String No rte-75eg4jprkvk0pw****

The ID of the route.

TransitRouterRouteEntryNextHopType String No BlackHole

The type of next hop. Valid values: Valid values:

  • BlackHole: a null interface. You do not need to specify the next hop.
  • Attachment: a network instance connection. You must specify a network instance connection as the next hop.
TransitRouterRouteEntryDestinationCidrBlock String No 192.168.0.0/24

The destination CIDR block.

TransitRouterRouteEntryNextHopId String No tr-attach-nls9fzkfat8934****

The ID of the network instance connection that you want to specify as the next hop.

TransitRouterRouteTableId String No vtb-bp1dudbh2d5na6b50****

The route table ID of the Enterprise Edition transit router.

Response parameters

Parameter Type Example Description
RequestId String 2D69CCEA-42D0-48B2-8C9A-9BB207F76D6E

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DeleteTransitRouterRouteEntry
&<Common request parameters>

Sample success responses

XML format

<DeleteTransitRouterRouteEntryResponse> 
  <RequestId>2D69CCEA-42D0-48B2-8C9A-9BB207F76D6E</RequestId>
</DeleteTransitRouterRouteEntryResponse>

JSON format

{
  "RequestId": "2D69CCEA-42D0-48B2-8C9A-9BB207F76D6E"
}

Error codes

HttpCode Error code Error message Description
400 DryRunOperation Request validation has been passed with DryRun flag set. The error message returned because the dry run request passes the precheck.

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