调用CreateCenRouteMap接口创建路由策略。
使用说明
路由策略按照优先级进行排列,优先级数字越小,优先级越高。每条路由策略都是条件语句和执行语句的集合。执行路由策略时,路由从优先级最高的路由策略开始匹配条件语句,对于符合全部匹配条件的路由,路由策略将按照策略行为允许路由通过或拒绝路由通过,允许通过的路由支持修改路由属性;对于不符合全部匹配条件的路由,系统默认允许路由通过。更多信息,请参见路由策略概述。
CreateCenRouteMap接口属于异步接口,即系统会先返回一个路由策略ID,但该路由策略并未创建完成,系统后台的创建任务仍在进行。您可以调用DescribeCenRouteMaps接口查询路由策略的状态。
- 当路由策略处于Creating状态时,表示路由策略正在创建中,在该状态下,您只能执行查询操作,不能执行其他操作。
- 当路由策略处于Active状态时,表示路由策略创建完成。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | CreateCenRouteMap |
系统规定参数。取值:CreateCenRouteMap。 |
| CenId | String | 是 | cen-7qthudw0ll6jmc**** |
云企业网实例ID。 |
| CenRegionId | String | 是 | cn-hangzhou |
路由策略应用的地域ID。 您可以通过调用DescribeChildInstanceRegions接口获取地域ID。 |
| TransmitDirection | String | 是 | RegionIn |
路由策略的应用方向。取值:
|
| Description | String | 否 | desctest |
路由策略的描述信息。 描述长度为2~256个字符,不能以 |
| Priority | Integer | 是 | 3 |
路由策略的优先级。取值范围:1~100。优先级数字越小,表示优先级越高。 说明 同地域、同应用方向的路由策略优先级唯一。执行路由策略时,系统从优先级数字最小的路由策略开始匹配条件语句,因此在指定路由策略优先级时,要注意符合期望的匹配顺序。
|
| MapResult | String | 是 | Permit |
所有条件都匹配后的策略行为。取值:
|
| NextPriority | Integer | 否 | 20 |
关联的下一条路由策略的优先级。
|
| CidrMatchMode | String | 否 | Include |
前缀列表的匹配模式。取值:
|
| AsPathMatchMode | String | 否 | Include |
AS Path列表的匹配模式。取值:
|
| CommunityMatchMode | String | 否 | Include |
Community的匹配模式。取值:
|
| CommunityOperateMode | String | 否 | Additive |
Community的执行模式。取值:
本参数表示路由通过匹配条件后,要执行的操作。 |
| Preference | Integer | 否 | 50 |
修改路由的优先级。 取值范围:1~100。路由的优先级默认为50,取值越小优先级越高。 本参数表示路由通过匹配条件后,要执行的操作。 |
| SourceInstanceIdsReverseMatch | Boolean | 否 | false |
是否使用源实例ID列表的排除匹配模式。取值:
|
| DestinationInstanceIdsReverseMatch | Boolean | 否 | false |
是否使用目的实例ID列表的排除匹配模式。取值:
|
| MatchAddressType | String | 否 | IPv4 |
路由需匹配的IP地址类型。取值:
本参数可以为空,表示匹配所有类型的路由。 |
| TransitRouterRouteTableId | String | 否 | vtb-gw8nx3515m1mbd1z1**** |
转发路由器的路由表ID。 如果您不输入路由表ID,则路由策略自动关联至转发路由器的默认路由表。 |
| SourceInstanceIds.N | String | 否 | vpc-adeg3544fdf34vf**** |
路由需匹配的源实例ID列表。支持输入以下类型的实例ID:
最多支持输入32个实例ID。 |
| DestinationInstanceIds.N | String | 否 | vpc-afrfs434465fdf**** |
路由需匹配的目的实例ID列表。支持输入以下类型的实例ID:
最多支持输入32个实例ID。 说明 仅路由策略的应用方向为出地域网关方向,且目的实例ID为本地域下的实例ID时,目的实例ID列表才会生效。
|
| SourceRouteTableIds.N | String | 否 | vtb-adfr233vf34rvd4**** |
路由需匹配的源路由表ID列表。最多支持输入32个路由表ID。 |
| DestinationRouteTableIds.N | String | 否 | vtb-adefrgtr144vf**** |
路由需匹配的目的路由表ID列表。最多支持输入32个路由表ID。 说明 仅路由策略的应用方向为出地域网关方向,且目的路由表ID为本地域下网络实例的路由表ID时,目的路由表ID列表才会生效。
|
| SourceRegionIds.N | String | 否 | cn-beijing |
路由需匹配的源地域ID列表。最多支持输入32个地域ID。 您可以通过调用DescribeChildInstanceRegions接口获取地域ID。 |
| SourceChildInstanceTypes.N | String | 否 | VPC |
路由需匹配的源实例类型列表。支持以下实例类型:
支持输入多种实例类型。 |
| DestinationChildInstanceTypes.N | String | 否 | VPC |
路由需匹配的目的实例类型列表。支持以下实例类型:
支持输入多种实例类型。 说明 仅路由策略的应用方向为出地域网关方向,且目的实例类型为本地域下的实例类型时,目的实例类型列表才会生效。
|
| DestinationCidrBlocks.N | String | 否 | 10.10.10.0/24 |
路由需匹配的前缀列表。 前缀列表中的IP地址段使用CIDR格式,最多支持输入32个IP地址段。 |
| RouteTypes.N | String | 否 | System |
路由需匹配的路由类型列表。支持以下路由类型:
支持输入多种路由类型。 |
| MatchAsns.N | Long | 否 | 65501 |
路由需匹配的AS Path列表。 最多支持输入32个AS号码。 说明 仅支持AS SEQUENCE,不支持AS SET、AS CONFED SEQUENCE和AS CONFED SET,即只能是AS号列表,不支持集合和子列表。
|
| MatchCommunitySet.N | String | 否 | 65501:1 |
路由需匹配的Community集合。 每个Community格式为n:m,n、m的取值范围为1~65535。Community需要符合RFC 1997,不支持Large Community(RFC 8092)。 最多支持输入32个Community。 说明 Community配置错误可能会导致路由不能发布到本地数据中心。
|
| OperateCommunitySet.N | String | 否 | 65501:1 |
要执行的Community集合。 每个Community格式为n:m,n、m的取值范围为1~65535。Community需要符合RFC 1997,不支持Large Communities(RFC 8092)。 最多支持输入32个Community。 说明 Community配置错误可能会导致路由不能发布到本地数据中心。
|
| PrependAsPath.N | Long | 否 | 65501 |
地域网关接收或发布路由时附加的AS Path。 路由策略应用方向不同,配置附加AS Path的要求也不同,具体如下:
本参数表示路由通过匹配条件后,要执行的操作。最多支持输入32个AS号码。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RouteMapId | String | cenrmap-w4yf7toozfol3q**** |
路由策略的ID。 |
| RequestId | String | 62172DD5-6BAC-45DF-8D44-56SDF467BAC |
请求ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=CreateCenRouteMap
&CenId=cen-7qthudw0ll6jmc****
&CenRegionId=cn-hangzhou
&Priority=3
&TransmitDirection=RegionIn
&MapResult=Permit
&<公共请求参数>
正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateCenRouteMapResponse>
<RouteMapId>cenrmap-w4yf7toozfol3q****</RouteMapId>
<RequestId>62172DD5-6BAC-45DF-8D44-56SDF467BAC</RequestId>
</CreateCenRouteMapResponse>
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RouteMapId" : "cenrmap-w4yf7toozfol3q****",
"RequestId" : "62172DD5-6BAC-45DF-8D44-56SDF467BAC"
}
错误码
| HttpCode | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | Forbidden.CenRouteMapExist | The specified CEN route map ID already exists. | 路由策略已经存在。 |
| 400 | InvalidOperation.NoEffictiveAction | No effective action be configured. | 没有有效的Action。 |
访问错误中心查看更多错误码。