全部产品
Search
文档中心

云企业网:CreateCenRouteMap - 创建路由策略

更新时间:Mar 01, 2024

通过路由策略功能,可以过滤路由信息,帮助您自定义管理云上网络互通能力,您可以调用CreateCenRouteMap接口创建路由策略。

接口说明

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

CreateCenRouteMap接口属于异步接口,即系统会先返回一个路由策略 ID,但该路由策略并未创建完成,系统后台的创建任务仍在进行。您可以调用DescribeCenRouteMaps接口查询路由策略的状态。

  • 当路由策略处于 Creating 状态时,表示路由策略正在创建中,在该状态下,您只能执行查询操作,不能执行其他操作。
  • 当路由策略处于 Active 状态时,表示路由策略创建完成。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cen:CreateCenRouteMapWrite
  • CenInstance
    acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}

请求参数

名称类型必填描述示例值
CenIdstring

云企业网实例 ID。

cen-7qthudw0ll6jmc****
CenRegionIdstring

路由策略应用的地域 ID。

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

cn-hangzhou
TransmitDirectionstring

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

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

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

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

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

RegionIn
Descriptionstring

路由策略的描述信息。

描述可以为空或长度为 1~256 个字符,不能以 http://或 https://开头。

desctest
Priorityinteger

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

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

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

  • Permit:允许匹配的路由通过。

  • Deny:拒绝匹配的路由通过。

Permit
NextPriorityinteger

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

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

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

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

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

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

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

Include
AsPathMatchModestring

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

  • Include:模糊匹配,匹配条件中的 AS Path 与被匹配路由的 AS Path 有重叠即判定为匹配成功。

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

Include
CommunityMatchModestring

Community 的匹配模式。取值:

  • Include:模糊匹配,匹配条件中的 Community 与被匹配路由的 Community 有重叠即判定为匹配成功。

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

Include
CommunityOperateModestring

Community 的执行模式。取值:

  • Additive:添加,表示为路由添加 Community。

  • Replace:替换,表示替换路由原有的 Community。

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

Additive
Preferenceinteger

修改路由的优先级。

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

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

50
SourceInstanceIdsReverseMatchboolean

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

  • false(默认值):否,即路由传递的源实例 ID 在SourceInstanceIds.N中时,匹配通过。

  • true:是,即路由传递的源实例 ID 不在SourceInstanceIds.N中时,匹配通过。

false
DestinationInstanceIdsReverseMatchboolean

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

  • false(默认值):否,即路由传递的目的实例 ID 在DestinationInstanceIds.N中时,匹配通过。

  • true:是,即路由传递的目的实例 ID 不在DestinationInstanceIds.N中时,匹配通过。

false
MatchAddressTypestring

路由需匹配的 IP 地址类型。取值:

  • IPv4:表示只匹配 IPv4 路由。
  • IPv6:表示只匹配 IPv6 路由。

本参数可以为空,表示匹配所有类型的路由。

IPv4
TransitRouterRouteTableIdstring

转发路由器的路由表 ID。

如果您不输入路由表 ID,则路由策略自动关联至转发路由器的默认路由表。

vtb-gw8nx3515m1mbd1z1****
SourceInstanceIdsarray

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

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

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

string

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

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

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

vpc-adeg3544fdf34vf****
DestinationInstanceIdsarray

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

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

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

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

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

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

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

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

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

string

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

vtb-adfr233vf34rvd4****
DestinationRouteTableIdsarray

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

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

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

说明 仅路由策略的应用方向为出地域网关方向,且目的路由表 ID 为本地域下网络实例的路由表 ID 时,目的路由表 ID 列表才会生效。
vtb-adefrgtr144vf****
SourceRegionIdsarray

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

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

string

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

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

cn-beijing
SourceChildInstanceTypesarray

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

  • VPC:专有网络实例。

  • VBR:边界路由器实例。

  • CCN:云连接网实例。

  • VPN:VPN 网关实例或者 IPsec 连接。

    • 如果 IPsec 连接或 SSL 服务端绑定了 VPN 网关实例,则 VPN 网关实例关联的 VPC 必须连接至转发路由器实例,且 VPN 网关实例必须运行 BGP 动态路由协议,本参数才能生效。
    • 如果 IPsec 连接直接绑定了转发路由器实例,则本参数生效。

支持输入多种实例类型。

string

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

  • VPC:专有网络实例。

  • VBR:边界路由器实例。

  • CCN:云连接网实例。

  • VPN:VPN 网关实例或 IPsec 连接。

    • 如果 IPsec 连接或 SSL 服务端绑定了 VPN 网关实例,则 VPN 网关实例关联的 VPC 必须连接至转发路由器实例,且 VPN 网关实例必须运行 BGP 动态路由协议,本参数才能生效。
    • 如果 IPsec 连接直接绑定了转发路由器实例,则本参数生效。

支持输入多种实例类型。

VPC
DestinationChildInstanceTypesarray

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

  • VPC:专有网络实例。

  • VBR:边界路由器实例。

  • CCN:云连接网实例。

  • VPN:IPsec 连接。

    说明 如果 IPsec 连接或者 SSL 服务端绑定了 VPN 网关实例,并通过 VPN 网关实例关联的 VPC 连接至了转发路由器实例,则本参数不生效。本参数仅当 IPsec 连接直接绑定转发路由器实例时才生效。

支持输入多种实例类型。

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

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

  • VPC:专有网络实例。

  • VBR:边界路由器实例。

  • CCN:云连接网实例。

  • VPN:IPsec 连接。

    说明 如果 IPsec 连接或者 SSL 服务端绑定了 VPN 网关实例,并通过 VPN 网关实例关联的 VPC 连接至了转发路由器实例,则本参数不生效。本参数仅当 IPsec 连接直接绑定转发路由器实例时才生效。

支持输入多种实例类型。

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

路由需匹配的前缀列表。

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

string

路由需匹配的前缀列表。

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

10.10.10.0/24
RouteTypesarray

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

  • System:系统路由,由系统自动生成的路由。

  • Custom:自定义路由,由用户手动添加的路由。

  • BGP:BGP 路由,通过 BGP 路由协议传播的路由。

支持输入多种路由类型。

string

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

  • System:系统路由,由系统自动生成的路由。

  • Custom:自定义路由,由用户手动添加的路由。

  • BGP:BGP 路由,通过 BGP 路由协议传播的路由。

支持输入多种路由类型。

System
MatchAsnsarray

路由需匹配的 AS Path 列表。

最多支持输入 32 个 AS 号码。

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

路由需匹配的 AS Path 列表。

最多支持输入 32 个 AS 号码。

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

路由需匹配的 Community 集合。

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

最多支持输入 32 个 Community。

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

路由需匹配的 Community 集合。

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

最多支持输入 32 个 Community。

说明 Community 配置错误可能会导致路由不能发布到本地数据中心。
65501:1
OperateCommunitySetarray

要执行的 Community 集合。

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

最多支持输入 32 个 Community。

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

要执行的 Community 集合。

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

最多支持输入 32 个 Community。

说明 Community 配置错误可能会导致路由不能发布到本地数据中心。
65501:1
PrependAsPatharray

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

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

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

  • 出地域网关方向配置附加 AS Path 时,匹配条件中必须配置目的实例 ID 列表。

本参数表示路由通过匹配条件后,要执行的操作。最多支持输入 32 个 AS 号码。

long

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

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

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

  • 出地域网关方向配置附加 AS Path 时,匹配条件中必须配置目的实例 ID 列表。

本参数表示路由通过匹配条件后,要执行的操作。最多支持输入 32 个 AS 号码。

65501

返回参数

名称类型描述示例值
object

返回结果。

RouteMapIdstring

路由策略的 ID。

cenrmap-w4yf7toozfol3q****
RequestIdstring

请求 ID。

62172DD5-6BAC-45DF-8D44-56SDF467BAC

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400Forbidden.CenRouteMapExistThe specified CEN route map ID already exists.路由策略已经存在。
400Invid.ParameterWhen using PrependAsPath in the RegionIn, SourceRegionId must be local region Id.-
400InvalidOperation.NoEffictiveActionNo effective action be configured.没有有效的Action。
400Invid.ParameterWhen using GatewayRegionId, SourceRegionId must not be nullGatewayRegionId, SourceRegionId不允许为空。
400Invid.ParameterWhen using GatewayRegionId, GatewayZoneId must not be nullGatewayRegionId, GatewayZoneId不允许为空。
400Invid.ParameterWhen using GatewayRegionId, SourceRegionId must not be the same with tr region idGatewayRegionId和SourceRegionId不能在同一个地域。
400Invid.ParameterGatewayRegionId is invalidGatewayRegionId不合法。
400Invid.ParameterTransitRouter not exist.TransitRouter不存在。
400Invid.ParameterSourceInstanceId is invalid.SourceInstanceId不合法。
400Invid.ParameterDestinationInstanceId is invalid.DestinationInstanceId不合法。
400IncorrectStatus.TransitRouterInstanceThe status of TransitRouter is incorrect.转发路由器状态不正确。
400InvalidDescriptionDescription is invalid.描述不合法。
400IllegalParam.ZoneIdThe specified ZoneId is illegal.传入的可用区非法
400InvalidParameterInvalid parameter.参数不合法。
400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。

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

变更历史

变更时间变更内容概要操作
2023-12-13OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2022-07-19OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:MatchAddressType