Deletes blackhole routes and static routes that point to network instance connections from the route tables of an Enterprise Edition transit router.
Operation description
Before you call this operation, take note of the following items:
-
If TransitRouterRouteEntryId is set, you must not set TransitRouterRouteTableId or TransitRouterRouteEntryDestinationCidrBlock. Otherwise, parameter conflicts will occur.
-
If TransitRouterRouteEntryId is not set, you must specify the set parameters based on the type of the next hop:
- To delete a blackhole route, you must set TransitRouterRouteTableId, TransitRouterRouteEntryDestinationCidrBlock, and TransitRouterRouteEntryNextHopType.
- If the route that you want to delete is not a blackhole route, you must set TransitRouterRouteTableId, TransitRouterRouteEntryDestinationCidrBlock, TransitRouterRouteEntryNextHopType, and TransitRouterRouteEntryNextHopId.
-
DeleteTransitRouterRouteEntry is an asynchronous operation. After you send a request, the system returns a request ID and runs the task in the system background. You can call the ListTransitRouterRouteEntries operation to query the status of a route entry.
- If a route entry is in the Deleting state, the route entry is being deleted. You can query the route entry but cannot perform other operations.
- If a route entry cannot be found, it is deleted.
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
Authorization information
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ClientToken | string | No | 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 all requests. The client token can contain only ASCII characters. Note
If you do not specify this parameter, the system automatically uses the value of RequestId as the value of ClientToken. The value of RequestId for each API request may be different.
| 02fb3da4-130e-11e9-8e44-001**** |
| DryRun | boolean | No | Specifies whether to check the request but not perform the operation. The system checks the permissions and the status of the specified instances. Valid values:
| false |
| TransitRouterRouteEntryId | string | No | The ID of the route entry. | rte-75eg4jprkvk0pw**** |
| TransitRouterRouteEntryNextHopType | string | No | The type of the next hop. Valid values:
| BlackHole |
| TransitRouterRouteEntryDestinationCidrBlock | string | No | The destination CIDR block. | 192.168.0.0/24 |
| TransitRouterRouteEntryNextHopId | string | No | The ID of the network instance connection that you want to specify as the next hop. | tr-attach-nls9fzkfat8934**** |
| TransitRouterRouteTableId | string | No | The ID of the route table of the Enterprise Edition transit router. | vtb-bp1dudbh2d5na6b50**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "2D69CCEA-42D0-48B2-8C9A-9BB207F76D6E"
}Error codes
| HTTP status code | 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 passed the precheck. |
| 400 | IllegalParam.TransitRouterRouteEntryId | TransitRouterRouteEntryId is not found. | The error message returned because the route ID of the transit router (TransitRouterRouteEntryId) is invalid. |
| 400 | ParamExclusive.RouteEntryIdAndRouteTableIdOrDestCidrBlock | RouteEntryId and TransitRouterRouteTableIdOrDestCidrBlock is mutually exclusive. | The error message returned because the RouteEntryId, TransitRouterRouteTableId, or DestCidrBlock parameter conflicts with each other. |
| 400 | InvalidTransitRouterRouteTableId.NotFound | TransitRouterRouteTableId is not found. | The error message returned because the specified route table ID of the transit router does not exist. |
| 400 | InvalidDestinationCidrBlock.NotFound | DestinationCidrBlock is not found. | The error message returned because the specified destination CIDR block does not exist. |
| 400 | OperationFailed.DeleteTransitRouterRouteEntry | Operation failed because this route entry is created automatically. | You cannot delete a route that is automatically created by the system. |
| 400 | IllegalParam.NextHopType | The NextHopType is illegal. | The error message returned because the NextHopType parameter is set to an invalid value. |
| 400 | IllegalParam.TransitRouterRouteTableId | The transitRouter route table id is illegal. | The error message returned because the route table ID of the transit router (TransitRouterRouteTableId) is invalid. |
| 400 | MissingParam.TransitRouterRouteEntryNextHopId | The parameter TransitRouterRouteEntryNextHopId is mandatory | The error message returned because the TransitRouterRouteEntryNextHopId parameter is not set. |
| 400 | InvalidParameter | Invalid parameter. | The error message returned because the parameter is set to an invalid value. |
| 400 | Unauthorized | The AccessKeyId is unauthorized. | The error message returned because you do not have the permissions to perform this operation. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-07-10 | The Error code has changed | View Change Details |
| 2023-10-18 | The Error code has changed | View Change Details |
| 2023-01-04 | The Error code has changed | View Change Details |