All Products
Search
Document Center

Cloud Enterprise Network:DeleteTransitRouterRouteEntry

Last Updated:Mar 04, 2024

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
cen:DeleteTransitRouterRouteEntryWrite
  • TransitRouterRouteEntry
    acs:cen:*:{#accountId}:centransitrouterroutentry/{#centransitrouterroutentryId}
  • TransitRouterRouteTable
    acs:cen:*:{#accountId}:centransitrouterroutentry/{#transitrouterroutetableId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClientTokenstringNo

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****
DryRunbooleanNo

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 (default): sends the request. If the request passes the precheck, the route is deleted.
  • true: sends a precheck request. The route is not deleted after the request passes the precheck. If you use this value, the system checks the required parameters and the request syntax. If the check fails, the corresponding error message is returned. If the request passes the check, the system returns the ID of the request.
false
TransitRouterRouteEntryIdstringNo

The ID of the route entry.

rte-75eg4jprkvk0pw****
TransitRouterRouteEntryNextHopTypestringNo

The type of the next hop. Valid values:

  • BlackHole: a blackhole route. You do not need to specify a next hop.
  • Attachment: a network instance connection. You must specify a network instance connection as the next hop.
BlackHole
TransitRouterRouteEntryDestinationCidrBlockstringNo

The destination CIDR block.

192.168.0.0/24
TransitRouterRouteEntryNextHopIdstringNo

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

tr-attach-nls9fzkfat8934****
TransitRouterRouteTableIdstringNo

The ID of the route table of the Enterprise Edition transit router.

vtb-bp1dudbh2d5na6b50****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

2D69CCEA-42D0-48B2-8C9A-9BB207F76D6E

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400DryRunOperationRequest validation has been passed with DryRun flag set.The error message returned because the dry run request passed the precheck.
400IllegalParam.TransitRouterRouteEntryIdTransitRouterRouteEntryId is not found.The error message returned because the route ID of the transit router (TransitRouterRouteEntryId) is invalid.
400ParamExclusive.RouteEntryIdAndRouteTableIdOrDestCidrBlockRouteEntryId and TransitRouterRouteTableIdOrDestCidrBlock is mutually exclusive.The error message returned because the RouteEntryId, TransitRouterRouteTableId, or DestCidrBlock parameter conflicts with each other.
400InvalidTransitRouterRouteTableId.NotFoundTransitRouterRouteTableId is not found.The error message returned because the specified route table ID of the transit router does not exist.
400InvalidDestinationCidrBlock.NotFoundDestinationCidrBlock is not found.The error message returned because the specified destination CIDR block does not exist.
400OperationFailed.DeleteTransitRouterRouteEntryOperation failed because this route entry is created automatically.You cannot delete a route that is automatically created by the system.
400InvalidParameterInvalid parameter.The error message returned because the parameter is set to an invalid value.
400UnauthorizedThe 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 timeSummary of changesOperation
2023-10-18The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
2023-01-04The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change