调用CreateCenRouteMap接口创建路由策略。

使用说明

路由策略支持过滤路由、修改路由属性,可帮助您自定义云上网络互通能力。

路由策略按照优先级进行排列,优先级数字越小,优先级越高。每条路由策略都是条件语句和执行语句的集合。执行路由策略时,路由从优先级最高的路由策略开始匹配条件语句,对于符合全部匹配条件的路由,路由策略将按照策略行为允许路由通过或拒绝路由通过,允许通过的路由支持修改路由属性;对于不符合全部匹配条件的路由,系统默认允许路由通过。更多信息,请参见路由策略概述

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateCenRouteMap

要执行的操作。取值:CreateCenRouteMap

CenId String cen-7qthudw0ll6jmc****

云企业网实例ID。

CenRegionId String cn-hangzhou

路由策略应用的地域ID。

您可以通过调用DescribeChildInstanceRegions接口获取地域ID。

Priority Integer 3

路由策略的优先级。取值范围:1~100。优先级数字越小,表示优先级越高。

说明 同地域、同应用方向的路由策略优先级唯一。执行路由策略时,系统从优先级数字最小的路由策略开始匹配条件语句,因此在指定路由策略优先级时,要注意符合期望的匹配顺序。
TransmitDirection String RegionIn

路由策略的应用方向。取值:

  • RegionIn:入地域网关方向,表示路由传入云企业网地域网关的方向。

    例如:路由从本地域的网络实例发布到本地域网关,或其他地域的路由发布到本地域网关。

  • RegionOut:出地域网关方向,表示路由传出云企业网地域网关的方向。

    例如:路由从本地域网关发布到本地域下的网络实例,或发布到其他地域的地域网关。

MapResult String Permit

所有条件都匹配后的策略行为。取值:

  • Permit:允许匹配的路由通过。
  • Deny:拒绝匹配的路由通过。
NextPriority Integer 20

关联的下一条路由策略的优先级。

  • MapResult取值为Permit时,才支持设置关联策略优先级,且被允许通过的路由才会继续匹配关联的下一条路由策略。
  • 要关联的下一条路由策略必须和当前路由策略拥有相同的地域和应用方向。
  • 关联的下一条路由策略的优先级必须低于当前路由策略的优先级。
Description String desctest

路由策略的描述信息。

描述不能以http://https://开始,必须以中文或英文开始,可包含数字、短划线(-)、半角句号(.)和下划线(_)。

SourceRegionIds.N RepeatList cn-beijing

路由需匹配的源地域ID列表。最多支持输入32个地域ID。

您可以通过调用DescribeChildInstanceRegions接口获取地域ID。

SourceInstanceIds.N RepeatList vpc-adeg3544fdf34vf****

路由需匹配的源实例ID列表。支持输入以下类型的实例ID:

  • 专有网络VPC(Virtual Private Cloud)实例ID
  • 边界路由器VBR(Virtual Border Router)实例ID
  • 云连接网CCN(Cloud Connect Network)实例ID
  • 智能接入网关(Smart Access Gateway)实例ID

最多支持输入32个实例ID。

SourceInstanceIdsReverseMatch Boolean false

是否使用源实例ID列表的排除匹配模式。取值:

  • false(默认值):否,即路由传递的源实例ID在SourceInstanceIds.N中时,匹配通过。
  • true:是,即路由传递的源实例ID不在SourceInstanceIds.N中时,匹配通过。
DestinationInstanceIds.N RepeatList vpc-afrfs434465fdf****

路由需匹配的目的实例ID列表。支持输入以下类型的实例ID:

  • 专有网络VPC(Virtual Private Cloud)实例ID
  • 边界路由器VBR(Virtual Border Router)实例ID
  • 云连接网CCN(Cloud Connect Network)实例ID
  • 智能接入网关(Smart Access Gateway)实例ID

最多支持输入32个实例ID。

说明 仅路由策略的应用方向为出地域网关方向,且目的实例ID为本地域下的实例ID时,目的实例ID列表才会生效。
DestinationInstanceIdsReverseMatch Boolean false

是否使用目的实例ID列表的排除匹配模式。取值:

  • false(默认值):否,即路由传递的目的实例ID在DestinationInstanceIds.N中时,匹配通过。
  • true:是,即路由传递的目的实例ID不在DestinationInstanceIds.N中时,匹配通过。
SourceRouteTableIds.N RepeatList vtb-adfr233vf34rvd4****

路由需匹配的源路由表ID列表。最多支持输入32个路由表ID。

DestinationRouteTableIds.N RepeatList vtb-adefrgtr144vf****

路由需匹配的目的路由表ID列表。最多支持输入32个路由表ID。

说明 仅路由策略的应用方向为出地域网关方向,且目的路由表ID为本地域下网络实例的路由表ID时,目的路由表ID列表才会生效。
SourceChildInstanceTypes.N RepeatList VPC

路由需匹配的源实例类型列表。支持以下实例类型:

  • VPC:专有网络实例。
  • VBR:边界路由器实例。
  • CCN:云连接网实例。
DestinationChildInstanceTypes.N RepeatList VPC

路由需匹配的目的实例类型列表。支持以下实例类型:

  • VPC:专有网络实例。
  • VBR:边界路由器实例。
  • CCN:云连接网实例。
说明 仅路由策略的应用方向为出地域网关方向,且目的实例类型为本地域下的实例类型时,目的实例类型列表才会生效。
DestinationCidrBlocks.N RepeatList 10.10.10.0/24

路由需匹配的前缀列表。

前缀列表中的IP地址段使用CIDR格式,最多支持输入32个IP地址段。

CidrMatchMode String Include

前缀列表的匹配模式。取值:

  • Include:模糊匹配。匹配条件中的路由前缀包含被匹配路由的路由前缀即判定为匹配成功。

    例如:定义10.10.0.0/16的策略可以模糊匹配到10.10.1.0/24的路由。

  • Complete:精确匹配。匹配条件中的路由前缀必须与被匹配路由的路由前缀一致,才判定为匹配成功。

    例如:定义10.10.0.0/16的策略仅可以精确匹配到10.10.0.0/16的路由。

RouteTypes.N RepeatList System

路由需匹配的路由类型列表。支持以下路由类型:

  • System:系统路由,由系统自动生成的路由。
  • Custom:自定义路由,由用户手动添加的路由。
  • BGP:BGP路由,通过BGP路由协议传播的路由。
MatchAsns.N RepeatList 65501

路由需匹配的AS Path列表。

说明 仅支持AS SEQUENCE,不支持AS SET、AS CONFED SEQUENCE和AS CONFED SET,即只能是AS号列表,不支持集合和子列表。
AsPathMatchMode String Include

AS Path列表的匹配模式。取值:

  • Include:模糊匹配,匹配条件中的AS Path与被匹配路由的AS Path有重叠即判定为匹配成功。
  • Complete:精确匹配,匹配条件中的AS Path必须与被匹配路由的AS Path一致,才判定为匹配成功。
MatchCommunitySet.N RepeatList 65501:1

路由需匹配的Community集合。

每个Community格式为n:m,n、m的取值范围为1~65535。Community需要符合RFC 1997,不支持Large Community(RFC 8092)。

最多支持输入32个Community。

说明 Community配置错误可能会导致路由不能发布到本地数据中心。
CommunityMatchMode String Include

Community的匹配模式。取值:

  • Include:模糊匹配,匹配条件中的Community与被匹配路由的Community有重叠即判定为匹配成功。
  • Complete:精确匹配,匹配条件中的Community必须与被匹配路由的Community一致,才判定为匹配成功。
CommunityOperateMode String Additive

Community的执行模式。取值:

  • Additive:添加,表示为路由添加Community。
  • Replace:替换,表示替换路由原有的Community。

本参数表示路由通过匹配条件后,要执行的操作。

OperateCommunitySet.N RepeatList 65501:1

要执行的Community集合。

每个Community格式为n:m,n、m的取值范围为1~65535。Community需要符合RFC 1997,不支持Large Communities(RFC 8092)。

最多支持输入32个Community。

说明 Community配置错误可能会导致路由不能发布到本地数据中心。
Preference Integer 22

修改路由的优先级。

取值范围:1~100。路由的优先级默认为50,取值越小优先级越高。

本参数表示路由通过匹配条件后,要执行的操作。

PrependAsPath.N RepeatList 65501

地域网关接收或发布路由时附加的AS Path。

路由策略应用方向不同,配置附加AS Path的要求也不同,具体如下:

  • 入地域网关方向配置附加AS Path时,匹配条件中必须配置源实例ID列表和源地域,且源地域必须与路由策略应用的地域一致。
  • 出地域网关方向配置附加AS Path时,匹配条件中必须配置目的实例ID列表。

本参数表示路由通过匹配条件后,要执行的操作。

返回数据

名称 类型 示例值 描述
RequestId String 62172DD5-6BAC-45DF-8D44-56SDF467BAC

请求ID。

RouteMapId String cenrmap-w4yf7toozfol3q****

路由策略的ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateCenRouteMap
&CenId=cen-7qthudw0ll6jmc****
&CenRegionId=cn-hangzhou
&Priority=3
&TransmitDirection=RegionIn
&MapResult=Permit
&<公共请求参数>

正常返回示例

XML格式

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

JSON格式

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

错误码

HttpCode 错误码 错误信息 描述
400 Forbidden.CenRouteMapExist The specified CEN route map ID already exists. 路由策略已经存在。
400 InvalidOperation.NoEffictiveAction No effective action be configured. 没有有效的Action。

访问错误中心查看更多错误码。