DeleteRouteMap - Cloud Enterprise Network - Alibaba Cloud Documentation Center

Operation description

If the route map to be deleted is still associated with any resources, this operation fails.

If route map rules exist under the route map, this operation is not supported.

The DeleteRouteMap operation is asynchronous. The system returns a RequestId, but the route map is not completely deleted. The deletion task continues in the background. You can call the ListRouteMaps operation to query the status of the route map.

If the route map is in the Deleting state, the route map is being deleted. In this state, you can only perform query operations.
If the route map cannot be queried by using the ListRouteMaps operation, the route map is completely deleted.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST / HTTP/1.1

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 generate the value from your client and make sure that the value is unique across different requests. The ClientToken parameter supports 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 of each API request may be different.	02fb3da4****
RouteMapId	string	Yes	The ID of the route map.	rm-w4yf7toozfol3q****
DryRun	boolean	No	Specifies whether to only precheck the request. Valid values: true: The system prechecks the request without deleting the route map. The system checks whether the required parameters are specified, the request format is valid, and the service limits are met. If the request fails the precheck, the system returns an error. If the request passes the precheck, the system returns the DryRunOperation error code. false (default): The system sends a normal request and deletes the route map after the request passes the precheck.	false

Response elements

Element	Type	Description	Example
	object	Deleted.
RequestId	string	The ID of the request.	F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1

Examples

Success response

JSON format

{
  "RequestId": "F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IncorrectStatus.RouteMap	RouteMap is not in a valid state for the operation.	RouteMap is not in a valid state for the operation.
400	InvalidOperation.RouteMapAssociationExist	Operation is invalid because the route map has active associations.	Operation is invalid because the route map has active associations.
400	InvalidOperation.RouteMapRuleExist	Operation is invalid because the route map contains rules.	Operation is invalid because the route map contains rules.
400	InstanceNotExist.RouteMap	The RouteMap does not exist.	The routing policy does not exist.
400	InvalidOperation.RouteMapPriorityConflict	Operation is invalid because the route map priority conflicts with existing maps.	Operation is invalid because the route map priority conflicts with existing maps.
400	InvalidParameter.RouteMapId	The specified parameter RouteMapId is invalid.	The parameter RouteMapId entered is illegal.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.