通过路由策略功能,可以过滤路由信息,帮助您自定义管理云上网络互通能力,您可以调用CreateCenRouteMap接口创建路由策略。
接口说明
路由策略按照优先级进行排列,优先级数字越小,优先级越高。每条路由策略都是条件语句和执行语句的集合。执行路由策略时,路由从优先级最高的路由策略开始匹配条件语句,对于符合全部匹配条件的路由,路由策略将按照策略行为允许路由通过或拒绝路由通过,允许通过的路由支持修改路由属性;对于不符合全部匹配条件的路由,系统默认允许路由通过。更多信息,请参见路由策略概述。
CreateCenRouteMap
接口属于异步接口,即系统会先返回一个路由策略 ID,但该路由策略并未创建完成,系统后台的创建任务仍在进行。您可以调用DescribeCenRouteMaps
接口查询路由策略的状态。
- 当路由策略处于 Creating 状态时,表示路由策略正在创建中,在该状态下,您只能执行查询操作,不能执行其他操作。
- 当路由策略处于 Active 状态时,表示路由策略创建完成。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
cen:CreateCenRouteMap | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
CenId | string | 是 | 云企业网实例 ID。 | cen-7qthudw0ll6jmc**** |
CenRegionId | string | 是 | 路由策略应用的地域 ID。 您可以通过调用 DescribeChildInstanceRegions 接口获取地域 ID。 | cn-hangzhou |
TransmitDirection | string | 是 | 路由策略的应用方向。取值:
例如:路由从本地域的网络实例发布到本地域网关,或其他地域的路由发布到本地域网关。
例如:路由从本地域网关发布到本地域下的网络实例,或发布到其他地域的地域网关。 | RegionIn |
Description | string | 否 | 路由策略的描述信息。 描述可以为空或长度为 1~256 个字符,不能以 http://或 https://开头。 | desctest |
Priority | integer | 是 | 路由策略的优先级。取值范围:1~100。优先级数字越小,表示优先级越高。 说明
同地域、同应用方向的路由策略优先级唯一。执行路由策略时,系统从优先级数字最小的路由策略开始匹配条件语句,因此在指定路由策略优先级时,要注意符合期望的匹配顺序。
| 3 |
MapResult | string | 是 | 所有条件都匹配后的策略行为。取值:
| Permit |
NextPriority | integer | 否 | 关联的下一条路由策略的优先级。
| 20 |
CidrMatchMode | string | 否 | 前缀列表的匹配模式。取值:
例如:定义 10.10.0.0/16 的策略可以模糊匹配到 10.10.1.0/24 的路由。
例如:定义 10.10.0.0/16 的策略仅可以精确匹配到 10.10.0.0/16 的路由。 | Include |
AsPathMatchMode | string | 否 | AS Path 列表的匹配模式。取值:
| Include |
CommunityMatchMode | string | 否 | Community 的匹配模式。取值:
| Include |
CommunityOperateMode | string | 否 | Community 的执行模式。取值:
本参数表示路由通过匹配条件后,要执行的操作。 | Additive |
Preference | integer | 否 | 修改路由的优先级。 取值范围:1~100。路由的优先级默认为 50,取值越小优先级越高。 本参数表示路由通过匹配条件后,要执行的操作。 | 50 |
SourceInstanceIdsReverseMatch | boolean | 否 | 是否使用源实例 ID 列表的排除匹配模式。取值:
| false |
DestinationInstanceIdsReverseMatch | boolean | 否 | 是否使用目的实例 ID 列表的排除匹配模式。取值:
| false |
MatchAddressType | string | 否 | 路由需匹配的 IP 地址类型。取值:
本参数可以为空,表示匹配所有类型的路由。 | IPv4 |
TransitRouterRouteTableId | string | 否 | 转发路由器的路由表 ID。 如果您不输入路由表 ID,则路由策略自动关联至转发路由器的默认路由表。 | vtb-gw8nx3515m1mbd1z1**** |
SourceInstanceIds | array | 否 | 路由需匹配的源实例 ID 列表。支持输入以下类型的实例 ID:
最多支持输入 32 个实例 ID。 | |
string | 否 | 路由需匹配的源实例 ID 列表。支持输入以下类型的实例 ID:
最多支持输入 32 个实例 ID。 | vpc-adeg3544fdf34vf**** | |
DestinationInstanceIds | array | 否 | 路由需匹配的目的实例 ID 列表。支持输入以下类型的实例 ID:
最多支持输入 32 个实例 ID。 说明
仅路由策略的应用方向为出地域网关方向,且目的实例 ID 为本地域下的实例 ID 时,目的实例 ID 列表才会生效。
| |
string | 否 | 路由需匹配的目的实例 ID 列表。支持输入以下类型的实例 ID:
最多支持输入 32 个实例 ID。 说明
仅路由策略的应用方向为出地域网关方向,且目的实例 ID 为本地域下的实例 ID 时,目的实例 ID 列表才会生效。
| vpc-afrfs434465fdf**** | |
SourceRouteTableIds | array | 否 | 路由需匹配的源路由表 ID 列表。最多支持输入 32 个路由表 ID。 | |
string | 否 | 路由需匹配的源路由表 ID 列表。最多支持输入 32 个路由表 ID。 | vtb-adfr233vf34rvd4**** | |
DestinationRouteTableIds | array | 否 | 路由需匹配的目的路由表 ID 列表。最多支持输入 32 个路由表 ID。 说明
仅路由策略的应用方向为出地域网关方向,且目的路由表 ID 为本地域下网络实例的路由表 ID 时,目的路由表 ID 列表才会生效。
| |
string | 否 | 路由需匹配的目的路由表 ID 列表。最多支持输入 32 个路由表 ID。 说明
仅路由策略的应用方向为出地域网关方向,且目的路由表 ID 为本地域下网络实例的路由表 ID 时,目的路由表 ID 列表才会生效。
| vtb-adefrgtr144vf**** | |
SourceRegionIds | array | 否 | 路由需匹配的源地域 ID 列表。最多支持输入 32 个地域 ID。 您可以通过调用 DescribeChildInstanceRegions 接口获取地域 ID。 | |
string | 否 | 路由需匹配的源地域 ID 列表。最多支持输入 32 个地域 ID。 您可以通过调用 DescribeChildInstanceRegions 接口获取地域 ID。 | cn-beijing | |
SourceChildInstanceTypes | array | 否 | 路由需匹配的源实例类型列表。支持以下实例类型:
支持输入多种实例类型。 | |
string | 否 | 路由需匹配的源实例类型列表。支持以下实例类型:
支持输入多种实例类型。 | VPC | |
DestinationChildInstanceTypes | array | 否 | 路由需匹配的目的实例类型列表。支持以下实例类型:
支持输入多种实例类型。 说明
仅路由策略的应用方向为出地域网关方向,且目的实例类型为本地域下的实例类型时,目的实例类型列表才会生效。
| |
string | 否 | 路由需匹配的目的实例类型列表。支持以下实例类型:
支持输入多种实例类型。 说明
仅路由策略的应用方向为出地域网关方向,且目的实例类型为本地域下的实例类型时,目的实例类型列表才会生效。
| VPC | |
DestinationCidrBlocks | array | 否 | 路由需匹配的前缀列表。 前缀列表中的 IP 地址段使用 CIDR 格式,最多支持输入 32 个 IP 地址段。 支持 IPv4、IPv6 格式。 | |
string | 否 | 路由需匹配的前缀列表。 前缀列表中的 IP 地址段使用 CIDR 格式,最多支持输入 32 个 IP 地址段。 支持 IPv4、IPv6 格式。 | 10.10.10.0/24 | |
RouteTypes | array | 否 | 路由需匹配的路由类型列表。支持以下路由类型:
支持输入多种路由类型。 | |
string | 否 | 路由需匹配的路由类型列表。支持以下路由类型:
支持输入多种路由类型。 | System | |
MatchAsns | array | 否 | 路由需匹配的 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 | |
MatchCommunitySet | array | 否 | 路由需匹配的 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 | |
OperateCommunitySet | array | 否 | 要执行的 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 | |
PrependAsPath | array | 否 | 地域网关接收或发布路由时附加的 AS Path。 路由策略应用方向不同,配置附加 AS Path 的要求也不同,具体如下:
本参数表示路由通过匹配条件后,要执行的操作。最多支持输入 32 个 AS 号码。 | |
long | 否 | 地域网关接收或发布路由时附加的 AS Path。 路由策略应用方向不同,配置附加 AS Path 的要求也不同,具体如下:
本参数表示路由通过匹配条件后,要执行的操作。最多支持输入 32 个 AS 号码。 | 65501 | |
DestinationRegionIds | array | 否 | 路由需匹配的目的地域 ID 列表。最多支持输入 32 个地域 ID。 | |
string | 否 | 路由需匹配的目的地域 ID 列表。最多支持输入 32 个地域 ID。 | cn-beijing |
返回参数
示例
正常返回示例
JSON
格式
{
"RouteMapId": "cenrmap-w4yf7toozfol3q****",
"RequestId": "62172DD5-6BAC-45DF-8D44-56SDF467BAC"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Forbidden.CenRouteMapExist | The specified CEN route map ID already exists. | 路由策略已经存在。 |
400 | Invid.Parameter | When using PrependAsPath in the RegionIn, SourceRegionId must be local region Id. | - |
400 | InvalidOperation.NoEffictiveAction | No effective action be configured. | 没有有效的Action。 |
400 | Invid.Parameter | When using GatewayRegionId, SourceRegionId must not be null | GatewayRegionId, SourceRegionId不允许为空。 |
400 | Invid.Parameter | When using GatewayRegionId, GatewayZoneId must not be null | GatewayRegionId, GatewayZoneId不允许为空。 |
400 | Invid.Parameter | When using GatewayRegionId, SourceRegionId must not be the same with tr region id | GatewayRegionId和SourceRegionId不能在同一个地域。 |
400 | Invid.Parameter | GatewayRegionId is invalid | GatewayRegionId不合法。 |
400 | Invid.Parameter | TransitRouter not exist. | TransitRouter不存在。 |
400 | Invid.Parameter | SourceInstanceId is invalid. | SourceInstanceId不合法。 |
400 | Invid.Parameter | DestinationInstanceId is invalid. | DestinationInstanceId不合法。 |
400 | IncorrectStatus.TransitRouterInstance | The status of TransitRouter is incorrect. | 转发路由器状态不正确。 |
400 | InvalidDescription | Description is invalid. | 描述不合法。 |
400 | IllegalParam.ZoneId | The specified ZoneId is illegal. | 传入的可用区非法 |
400 | InvalidParameter | Invalid parameter. | 参数不合法。 |
400 | Unauthorized | The AccessKeyId is unauthorized. | 账号无权限操作。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-09-18 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2024-09-10 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2024-09-10 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-12-13 | OpenAPI 错误码发生变更 | 查看变更详情 |
2022-07-19 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |