CreateRouteMap - Cloud Enterprise Network - Alibaba Cloud Documentation Center

Creates a route map to control the routing behavior between network instances.

Operation description

The CreateRouteMap operation is asynchronous. The system returns a route map ID before the route map is created, and the creation 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 Creating state, the route map is being created. In this state, you can only perform query operations.
If the route map is in the Active state, the route map is created.

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:CreateRouteMap

create

*RouteMap

acs:cen:*:{#accountId}:routemap/*

None

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 parameter value on your client. Make sure that the token is unique among different requests. The client token only supports 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-130e-11e9-8e44-001****
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://.	test
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://.	descname
Priority	integer	Yes	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 under an Alibaba Cloud account must be unique. When a route map is applied, the system starts matching route map rules from the route map with the smallest priority value based on policy priority of the route map rules. Therefore, when you specify policy priority of a route map, make sure that policy priority meets the expected matching order.	3
Direction	string	Yes	The direction of the route map. Valid values: Inbound: inbound. The direction in which the instance route table receives routes from the associated network instance. This affects the routes that the current instance can learn from the associated network instance. Outbound: outbound. The direction in which the instance route table sends routes to the associated network instance. This affects the routes that the current instance advertises to the associated network instance. Valid values: Outbound : Outbound. Inbound : Inbound.	Inbound
Tag	array<object>	No	The tag information. You can specify up to 20 tags at a time.
	object	No
Key	string	No	The tag key of the resource. The tag key cannot be an empty string. It can be up to 64 characters in length, and cannot start with aliyun or acs:. It cannot contain http:// or https://. You can specify up to 20 tag keys at a time.	tagtest
Value	string	No	The tag value of the resource. The tag value cannot be empty. It can be up to 128 characters in length, and cannot start with aliyun or acs:. It cannot contain http:// or https://. Each tag key corresponds to a tag value. You can specify up to 20 tag values at a time.	tagtest
ResourceGroupId	string	No	The ID of the resource group.	rg-acfm3unpnuw****
DryRun	boolean	No	Specifies whether to perform a dry run on the request. The dry run includes checks on permissions and instance status. Valid values: false (default): sends a normal request. If the request passes the check, the route map is created. true: sends a dry run request. The system only checks the request and does not create the route map. The check items include whether required parameters are specified and whether the request format is valid. If the request fails the check, the corresponding error is returned. If the request passes the check, the `DryRunOperation` error code is returned.	false

Response elements

Element	Type	Description	Example
	object	The route map is created.
RouteMapId	string	The ID of the route map.	rm-abcdedfghij****
RequestId	string	The ID of the request.	0C2EE7A8-74D4-4081-8236-CEBDE3BBCF50

Examples

Success response

JSON format

{
  "RouteMapId": "rm-abcdedfghij****",
  "RequestId": "0C2EE7A8-74D4-4081-8236-CEBDE3BBCF50"
}

Error codes

HTTP status code	Error code	Error message	Description
400	QuotaExceeded.RouteMap	The maximum number of RouteMap is exceeded.	The number of routing policies exceeds the limit.
400	OperationUnsupported.RouteMap	Operate RouteMap is not supported.	Operate RouteMap is not supported.
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	InvalidName	The name is invalid	The error message returned because the specified name is invalid.
400	InvalidDescription	The description is invalid	The error message returned because the description is invalid.
400	InvalidParameter.Priority	The specified priority is invalid.	The specified priority is invalid.
400	InvalidParameter.Direction	The specified direction is invalid.	The specified direction is invalid.
400	InvalidParameter.TagValue	The specified parameter TagValue is invalid.	The input parameter Tag Value is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.