UpdateRouteMap - Cloud Enterprise Network - Alibaba Cloud Documentation Center

Operation description

The UpdateRouteMap operation is asynchronous. After you call this operation, the system returns a RequestId, but the route map is not immediately updated. The update task continues to run in the background. You can call the ListRouteMaps operation to query the status of the route map.

If the route map is in the Updating state, the route map is being updated. In this state, you can only perform query operations.
If the route map is in the Active state, the route map is updated.

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 use the client to generate the value, but you must ensure that it 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 client token. The RequestId of each API request may be different.	123e4567-e89b-12d3-a456-42665544****
RouteMapId	string	Yes	The ID of the route map.	rm-abcdedfghij****
Name	string	No	The name of the route map. The name can be empty or 1 to 128 characters in length. It cannot start with http:// or https://.	nametest
Description	string	No	The description of the route map. The description can be empty or 1 to 256 characters in length. It cannot start with http:// or https://.	desctest
Priority	integer	No	Policy priority of the route map. Valid values: 1 to 100. A smaller value indicates a higher priority. Note Policy priority of each route map within an Alibaba Cloud account must be unique. When a route map is applied, the system starts to match routes against the rules of the route map that has the highest priority (the smallest priority value) and then proceeds to route maps with lower priorities based on the rule priorities. Therefore, when you specify policy priority of a route map, make sure that policy priority meets your expected matching order.	3
DryRun	boolean	No	Specifies whether to only precheck the request. Valid values: true: prechecks the request without updating the route map. The system checks whether required parameters are specified, the request format is valid, and the service limits are met. If the request fails the precheck, the corresponding error is returned. If the request passes the precheck, the DryRunOperation error code is returned. false (default): sends the request. If the request passes the precheck, the route map is updated.	false

Response elements

Element	Type	Description	Example
	object	The route map is updated.
RequestId	string	The ID of the request.	2315DEB7-5E92-423A-91F7-4C1EC9AD97C3

Examples

Success response

JSON format

{
  "RequestId": "2315DEB7-5E92-423A-91F7-4C1EC9AD97C3"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InstanceNotExist.RouteMap	The RouteMap does not exist.	The routing policy does not exist.
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.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	InvalidDescription	The description is invalid	The error message returned because the description is invalid.
400	InvalidName	The name is invalid	The error message returned because the specified name is invalid.
400	MissingParameter.RouteMapId	The parameter RouteMapId is mandatory.	The parameter RouteMapId is mandatory.
400	InvalidParameter.Priority	The specified priority is invalid.	The specified priority is invalid.
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.