Call DeleteTransitRouterRouteEntry to delete a static route - Cloud Enterprise Network - Alibaba Cloud - Cloud Enterprise Network

Calls the DeleteTransitRouterRouteEntry operation to delete static route entries of the blackhole or connection instance type from an Enterprise Edition transit router route table.

Operation description

Before you call this operation to delete a route entry, take note of the following information:

If you specify TransitRouterRouteEntryId to delete a route entry, you do not need to specify TransitRouterRouteTableId or TransitRouterRouteEntryDestinationCidrBlock. Otherwise, a parameter conflict error occurs.
If you do not specify TransitRouterRouteEntryId to delete a route entry, specify the corresponding parameters based on the next hop type of the route entry:
- To delete a blackhole route, specify TransitRouterRouteTableId, TransitRouterRouteEntryDestinationCidrBlock, and TransitRouterRouteEntryNextHopType.
- To delete a non-blackhole route, specify TransitRouterRouteTableId, TransitRouterRouteEntryDestinationCidrBlock, TransitRouterRouteEntryNextHopType, and TransitRouterRouteEntryNextHopId.
DeleteTransitRouterRouteEntry is an asynchronous operation. After you send a request, the system returns a RequestId but the route entry is not immediately deleted. The deletion task runs in the background. You can call ListTransitRouterRouteEntries to query the status of the route entry.
- If the route entry is in the Deleting state, the route entry is being deleted. In this state, you can only perform query operations on the route entry but cannot perform other operations on it.
- If the route entry cannot be found, the route entry is deleted.

Before you begin

This operation can delete only static route entries. Automatically learned route entries cannot be deleted. You can call ListTransitRouterRouteEntries to query the type of a route entry.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cen:DeleteTransitRouterRouteEntry

delete

TransitRouterRouteEntry

acs:cen:*:{#accountId}:centransitrouterroutentry/{#centransitrouterroutentryId}

TransitRouterRouteTable

acs:cen:*:{#accountId}:centransitrouterroutentry/{#transitrouterroutetableId}

None

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 token, but you must make sure that the token is unique among different requests. The client token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.	02fb3da4-130e-11e9-8e44-001****
DryRun	boolean	No	Specifies whether to perform a dry run. The dry run checks parameter validity, user permissions, and instance status. Valid values: false (default): Sends the request. If the request passes the check, the route entry is deleted. true: Sends a check request. No route entry is deleted after the request passes the check. The system checks the required parameters, request format, and other conditions. If the check fails, the corresponding error is returned. If the check succeeds, the corresponding request ID is returned.	false
TransitRouterRouteEntryId	string	No	The ID of the route entry.	rte-75eg4jprkvk0pw****
TransitRouterRouteEntryNextHopType	string	No	The next hop type of the route entry. Valid values: BlackHole: The route entry is a blackhole route. You do not need to specify next-hop information. Attachment: The next hop of the route entry is a network instance connection. You must also specify the ID of the network instance connection as the next hop.	BlackHole
TransitRouterRouteEntryDestinationCidrBlock	string	No	The destination CIDR block.	192.168.0.0/24
TransitRouterRouteEntryNextHopId	string	No	The ID of the network instance connection associated with the next hop of the route entry.	tr-attach-nls9fzkfat8934****
TransitRouterRouteTableId	string	No	The ID of the Enterprise Edition transit router route table.	vtb-bp1dudbh2d5na6b50****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	2D69CCEA-42D0-48B2-8C9A-9BB207F76D6E

Examples

Success response

JSON format

{
  "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.
400	InvalidParameter.TransitRouterRouteEntryId	The specified parameter TransitRouterRouteEntryId is invalid.	The parameter TransitRouterRouteEntryId entered is illegal.
400	InvalidParameter.TransitRouterRouteEntryNextHopId	The specified parameter TransitRouterRouteEntryNextHopId is invalid.	The parameter TransitRouterRouteEntryNextHopId entered is illegal.
400	InvalidParameter.TransitRouterRouteTableId	The specified parameter TransitRouterRouteTableId is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.