Creates a route map.

Usage notes

You can use route maps to filter routes and modify route attributes. This allows you to manage the connectivity between network instances attached to a Cloud Enterprise Network (CEN) instance.

Route maps are sorted by priority. A smaller value indicates a higher priority. Each route map is a collection of conditional statements and execution statements. Conditional statements specify the match conditions that routes are evaluated against. Execution statements specify the actions to be performed based on matching results. Starting from the route map with the highest priority, the system evaluates routes against the match conditions specified by route maps. If a route meets all the match conditions of a route map, the system permits or denies the route based on the action specified by the route map. You can also modify the attributes of permitted routes. By default, the system permits routes that meet none of the match conditions. For more information, see Route map overview.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String No CreateCenRouteMap

The operation that you want to perform. Set the value to CreateCenRouteMap.

CenId String Yes cen-7qthudw0ll6jmc****

The ID of the CEN instance.

CenRegionId String Yes cn-hangzhou

The ID of the region where the route map is applied.

You can call the DescribeChildInstanceRegions operation to query the most recent region list.

Priority Integer Yes 3

The priority of the route map. Valid values: 1 to 100. A smaller value indicates a higher priority.

Note The priority of each route map applied in one region and direction must be unique. The system evaluates routes against the match conditions of route maps in the descending order of priority. A smaller value indicates a higher priority. Therefore, set appropriate values to sort the route maps in the desired order.
TransmitDirection String Yes RegionIn

The direction in which the route map is applied. Valid values:

  • RegionIn: Routes are advertised to the gateways in the regions that are connected by the CEN instance.

    For example, routes are advertised from network instances deployed in the current region or other regions to the gateway deployed in the current region.

  • RegionOut: Routes are advertised from the gateways in the regions that are connected by the CEN instance.

    For example, routes are advertised from the gateway deployed in the current region to network instances deployed in the same region, or to gateways deployed in other regions.

MapResult String Yes Permit

The action to be performed on a route that meets all match conditions. Valid values:

  • Permit: the route is permitted.
  • Deny: the route is denied.
NextPriority Integer No 20

The priority of the next associated route map.

  • This parameter takes effect only when the MapResult parameter is set to Permit. This way, the permitted route is evaluated against the next route map.
  • The region and direction of the next route map must be the same as those of the current route map.
  • The priority of the next route map must be lower than the priority of the current route map.
Description String No desctest

The description of the route map.

The description cannot start with http:// or https://. It must start with a letter and can contain letters, digits, hyphens (-), periods (.), and underscores (_).

SourceRegionIds.N RepeatList No cn-beijing

The IDs of the source regions from which routes are evaluated. You can enter at most 32 region IDs.

You can call the DescribeChildInstanceRegions operation to query the most recent region list.

SourceInstanceIds.N RepeatList No vpc-adeg3544fdf34vf****

The IDs of the source network instances from which routes are evaluated. The following types of network instances are supported:

  • VPC
  • VBR
  • CCN
  • SAG

You can enter at most 32 network instance IDs.

SourceInstanceIdsReverseMatch Boolean No false

Specifies whether to exclude the source network instance IDs. Valid values:

  • false (default value): A route meets the match condition if its source network instance ID is in the list specified by SourceInstanceIds.N.
  • true: A route meets the match condition if its source network instance ID is not in the list specified by SourceInstanceIds.N.
DestinationInstanceIds.N RepeatList No vpc-afrfs434465fdf****

The IDs of the destination network instances to which routes are evaluated. The following types of network instances are supported:

  • VPC
  • VBR
  • CCN
  • SAG

You can enter at most 32 network instance IDs.

Note The destination network instance IDs are valid only when the route map is applied to scenarios where routes are advertised from the gateway in the current region to network instances in the current region.
DestinationInstanceIdsReverseMatch Boolean No false

Specifies whether to exclude the destination network instance IDs. Valid values:

  • false (default value): A route meets the match condition if its destination network instance ID is in the list specified by DestinationInstanceIds.N.
  • true: A route meets the match condition if its destination network instance ID is not in the list specified by DestinationInstanceIds.N.
SourceRouteTableIds.N RepeatList No vtb-adfr233vf34rvd4****

The IDs of the source route tables from which routes are evaluated. You can enter at most 32 route table IDs.

DestinationRouteTableIds.N RepeatList No vtb-adefrgtr144vf****

The IDs of the destination route tables to which routes are evaluated. You can enter at most 32 route table IDs.

Note The destination route table IDs are valid only when the route map is applied to scenarios where routes are advertised from the gateway in the current region to route tables in the current region.
SourceChildInstanceTypes.N RepeatList No VPC

The types of source network instances from which routes are evaluated. The following types of network instances are supported:

  • VPC
  • VBR
  • CCN
DestinationChildInstanceTypes.N RepeatList No VPC

The types of destination network instances to which routes are evaluated. The following types of network instances are supported:

  • VPC
  • VBR
  • CCN
Note The destination network instance types are valid only when the route map is applied to scenarios where routes are advertised from the gateway in the current region to network instances in the current region.
DestinationCidrBlocks.N RepeatList No 10.10.10.0/24

The prefixes of matching routes.

You must specify the IP addresses in CIDR notation. You can enter at most 32 CIDR blocks.

CidrMatchMode String No Include

The match method that is used to evaluate routes based on the prefix. Valid values:

  • Include: fuzzy match. A route meets the match condition if the route prefix specified in the match condition contains the prefix of the route.

    For example, if you set the match condition to 10.10.0.0/16 and fuzzy match is applied, the route whose prefix is 10.10.1.0/24 meets the match condition.

  • Complete: exact match. A route meets the match condition only if the prefix of the route is the same as the route prefix specified in the match condition.

    For example, if you set the match condition to 10.10.0.0/16 and exact match is applied, only the route whose prefix is 10.10.0.0/16 meets the match condition.

RouteTypes.N RepeatList No System

The type of route that is evaluated. Valid values: The following route types are supported:

  • System: system routes that are automatically generated by the system.
  • Custom: custom routes that are manually added.
  • BGP: routes that are advertised over Border Gateway Protocol (BGP).
MatchAsns.N RepeatList No 65501

The AS paths based on which routes are evaluated.

Note Only the AS-SEQUENCE parameter is supported. The AS-SET, AS-CONFED-SEQUENCE, and AS-CONFED-SET parameters are not supported. Specifically, only the AS number list is supported. Sets and sub-lists are not supported.
AsPathMatchMode String No Include

The match method that is used to evaluate routes based on the AS path. Valid values:

  • Include: fuzzy match. A route meets the match condition if the AS path of the route overlaps with the AS path specified in the match condition.
  • Complete: exact match. A route meets the match condition only if the AS path of the route is the same as the AS path specified in the match condition.
MatchCommunitySet.N RepeatList No 65501:1

The community set based on which routes are evaluated.

Specify the community in the format of n:m. Valid values of n and m: 1 to 65535. Each community must comply with RFC 1997. RFC 8092 that defines BGP large communities is not supported.

You can enter at most 32 communities.

Note If the configurations of the communities are incorrect, routes may not be advertised to your data center.
CommunityMatchMode String No Include

The match method that is used to evaluate routes based on the community. Valid values:

  • Include: fuzzy match. A route meets the match condition if the community of the route overlaps with the community specified in the match condition.
  • Complete: exact match. A route meets the match condition only if the community of the route is the same as the community specified in the match condition.
CommunityOperateMode String No Additive

The action that is performed on the community of the route. Valid values:

  • Additive: adds the community to the route.
  • Replace: replaces the original community of the route.

The parameter specifies the action to be performed when a route meets the match condition.

OperateCommunitySet.N RepeatList No 65501:1

The community set on which actions are performed.

Specify the community in the format of n:m. Valid values of n and m: 1 to 65535. Each community must comply with RFC 1997. RFC 8092 that defines BGP large communities is not supported.

You can enter at most 32 communities.

Note If the configurations of the communities are incorrect, routes may not be advertised to your data center.
Preference Integer No 22

The new priority of the route.

Valid values: 1 to 100. The default priority is 50. A smaller value indicates a higher priority.

The parameter specifies the action to be performed when a route meets the match condition.

PrependAsPath.N RepeatList No 65501

The AS paths that are prepended by using an action statement when regional gateways receive or advertise routes.

The AS paths vary based on the direction in which the route map is applied:

  • If AS paths are prepended to a route map applied in the inbound direction, you must specify source network instance IDs and the source region in the match condition. In addition, the source region must be the same as the region where the route map is applied.
  • If AS paths are prepended to a route map applied in the outbound direction, you must specify destination network instance IDs in the match condition.

The parameter specifies the action to be performed when a route meets the match condition.

Response parameters

Parameter Type Example Description
RequestId String 62172DD5-6BAC-45DF-8D44-56SDF467BAC

The ID of the request.

RouteMapId String cenrmap-w4yf7toozfol3q****

The ID of the route map.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateCenRouteMap
&CenId=cen-7qthudw0ll6jmc****
&CenRegionId=cn-hangzhou
&Priority=3
&TransmitDirection=RegionIn
&MapResult=Permit
&<Common request parameters>

Sample success responses

XML format

<CreateCenRouteMapResponse>
  <RequestId>62172DD5-6BAC-45DF-8D44-56SDF467BAC</RequestId>
  <RouteMapId>cenrmap-w4yf7toozfol3q****</RouteMapId>
</CreateCenRouteMapResponse>

JSON format

{
    "RequestId": "62172DD5-6BAC-45DF-8D44-56SDF467BAC",
    "RouteMapId": "cenrmap-w4yf7toozfol3q****"
}

Error codes

HttpCode Error code Error message Description
400 Forbidden.CenRouteMapExist The specified CEN route map ID already exists. The error message returned because the router map already exists.
400 InvalidOperation.NoEffictiveAction No effective action be configured. The error message returned because the specified action is invalid.

For a list of error codes, visit the API Error Center.