通過路由策略功能，可以過濾路由信息，幫助您自定義管理云上網絡互通能力，您可以調用CreateCenRouteMap接口創建路由策略。
接口說明
路由策略按照優先級進行排列，優先級數字越小，優先級越高。每條路由策略都是條件語句和執行語句的集合。執行路由策略時，路由從優先級最高的路由策略開始匹配條件語句，對于符合全部匹配條件的路由，路由策略將按照策略行為允許路由通過或拒絕路由通過，允許通過的路由支持修改路由屬性；對于不符合全部匹配條件的路由，系統默認允許路由通過。更多信息，請參見路由策略概述。
CreateCenRouteMap接口屬于異步接口，即系統會先返回一個路由策略 ID，但該路由策略并未創建完成，系統后臺的創建任務仍在進行。您可以調用DescribeCenRouteMaps接口查詢路由策略的狀態。
- 當路由策略處于 Creating 狀態時，表示路由策略正在創建中，在該狀態下，您只能執行查詢操作，不能執行其他操作。
- 當路由策略處于 Active 狀態時，表示路由策略創建完成。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| cen:CreateCenRouteMap | create | *CenInstance acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId} |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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-11-22 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2024-09-18 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2024-09-10 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2024-09-10 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2023-12-13 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2022-07-19 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |