通過路由策略功能，可以過濾路由信息，幫助您自定義管理云上網(wǎng)絡(luò)互通能力，您可以調(diào)用CreateCenRouteMap接口創(chuàng)建路由策略。
接口說明
路由策略按照優(yōu)先級(jí)進(jìn)行排列，優(yōu)先級(jí)數(shù)字越小，優(yōu)先級(jí)越高。每條路由策略都是條件語句和執(zhí)行語句的集合。執(zhí)行路由策略時(shí)，路由從優(yōu)先級(jí)最高的路由策略開始匹配條件語句，對(duì)于符合全部匹配條件的路由，路由策略將按照策略行為允許路由通過或拒絕路由通過，允許通過的路由支持修改路由屬性；對(duì)于不符合全部匹配條件的路由，系統(tǒng)默認(rèn)允許路由通過。更多信息，請(qǐng)參見路由策略概述。
CreateCenRouteMap接口屬于異步接口，即系統(tǒng)會(huì)先返回一個(gè)路由策略 ID，但該路由策略并未創(chuàng)建完成，系統(tǒng)后臺(tái)的創(chuàng)建任務(wù)仍在進(jìn)行。您可以調(diào)用DescribeCenRouteMaps接口查詢路由策略的狀態(tài)。
- 當(dāng)路由策略處于 Creating 狀態(tài)時(shí)，表示路由策略正在創(chuàng)建中，在該狀態(tài)下，您只能執(zhí)行查詢操作，不能執(zhí)行其他操作。
- 當(dāng)路由策略處于 Active 狀態(tài)時(shí)，表示路由策略創(chuàng)建完成。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別：是指每個(gè)操作的訪問級(jí)別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對(duì)于必選的資源類型，用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| cen:CreateCenRouteMap | create | *CenInstance acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId} |
| 無 |
請(qǐng)求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| CenId | string | 是 | 云企業(yè)網(wǎng)實(shí)例 ID。 | cen-7qthudw0ll6jmc**** |
| CenRegionId | string | 是 | 路由策略應(yīng)用的地域 ID。 您可以通過調(diào)用 DescribeChildInstanceRegions 接口獲取地域 ID。 | cn-hangzhou |
| TransmitDirection | string | 是 | 路由策略的應(yīng)用方向。取值：
例如：路由從本地域的網(wǎng)絡(luò)實(shí)例發(fā)布到本地域網(wǎng)關(guān)，或其他地域的路由發(fā)布到本地域網(wǎng)關(guān)。
例如：路由從本地域網(wǎng)關(guān)發(fā)布到本地域下的網(wǎng)絡(luò)實(shí)例，或發(fā)布到其他地域的地域網(wǎng)關(guān)。 | RegionIn |
| Description | string | 否 | 路由策略的描述信息。 描述可以為空或長度為 1～256 個(gè)字符，不能以 http://或 https://開頭。 | desctest |
| Priority | integer | 是 | 路由策略的優(yōu)先級(jí)。取值范圍：1~100。優(yōu)先級(jí)數(shù)字越小，表示優(yōu)先級(jí)越高。 說明
同地域、同應(yīng)用方向的路由策略優(yōu)先級(jí)唯一。執(zhí)行路由策略時(shí)，系統(tǒng)從優(yōu)先級(jí)數(shù)字最小的路由策略開始匹配條件語句，因此在指定路由策略優(yōu)先級(jí)時(shí)，要注意符合期望的匹配順序。
| 3 |
| MapResult | string | 是 | 所有條件都匹配后的策略行為。取值：
| Permit |
| NextPriority | integer | 否 | 關(guān)聯(lián)的下一條路由策略的優(yōu)先級(jí)。
| 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 的執(zhí)行模式。取值：
本參數(shù)表示路由通過匹配條件后，要執(zhí)行的操作。 | Additive |
| Preference | integer | 否 | 修改路由的優(yōu)先級(jí)。 取值范圍：1~100。路由的優(yōu)先級(jí)默認(rèn)為 50，取值越小優(yōu)先級(jí)越高。 本參數(shù)表示路由通過匹配條件后，要執(zhí)行的操作。 | 50 |
| SourceInstanceIdsReverseMatch | boolean | 否 | 是否使用源實(shí)例 ID 列表的排除匹配模式。取值：
| false |
| DestinationInstanceIdsReverseMatch | boolean | 否 | 是否使用目的實(shí)例 ID 列表的排除匹配模式。取值：
| false |
| MatchAddressType | string | 否 | 路由需匹配的 IP 地址類型。取值：
本參數(shù)可以為空，表示匹配所有類型的路由。 | IPv4 |
| TransitRouterRouteTableId | string | 否 | 轉(zhuǎn)發(fā)路由器的路由表 ID。 如果您不輸入路由表 ID，則路由策略自動(dòng)關(guān)聯(lián)至轉(zhuǎn)發(fā)路由器的默認(rèn)路由表。 | vtb-gw8nx3515m1mbd1z1**** |
| SourceInstanceIds | array | 否 | 路由需匹配的源實(shí)例 ID 列表。支持輸入以下類型的實(shí)例 ID：
最多支持輸入 32 個(gè)實(shí)例 ID。 | |
| string | 否 | 路由需匹配的源實(shí)例 ID 列表。支持輸入以下類型的實(shí)例 ID：
最多支持輸入 32 個(gè)實(shí)例 ID。 | vpc-adeg3544fdf34vf**** | |
| DestinationInstanceIds | array | 否 | 路由需匹配的目的實(shí)例 ID 列表。支持輸入以下類型的實(shí)例 ID：
最多支持輸入 32 個(gè)實(shí)例 ID。 說明
僅路由策略的應(yīng)用方向?yàn)槌龅赜蚓W(wǎng)關(guān)方向，且目的實(shí)例 ID 為本地域下的實(shí)例 ID 時(shí)，目的實(shí)例 ID 列表才會(huì)生效。
| |
| string | 否 | 路由需匹配的目的實(shí)例 ID 列表。支持輸入以下類型的實(shí)例 ID：
最多支持輸入 32 個(gè)實(shí)例 ID。 說明
僅路由策略的應(yīng)用方向?yàn)槌龅赜蚓W(wǎng)關(guān)方向，且目的實(shí)例 ID 為本地域下的實(shí)例 ID 時(shí)，目的實(shí)例 ID 列表才會(huì)生效。
| vpc-afrfs434465fdf**** | |
| SourceRouteTableIds | array | 否 | 路由需匹配的源路由表 ID 列表。最多支持輸入 32 個(gè)路由表 ID。 | |
| string | 否 | 路由需匹配的源路由表 ID 列表。最多支持輸入 32 個(gè)路由表 ID。 | vtb-adfr233vf34rvd4**** | |
| DestinationRouteTableIds | array | 否 | 路由需匹配的目的路由表 ID 列表。最多支持輸入 32 個(gè)路由表 ID。 說明
僅路由策略的應(yīng)用方向?yàn)槌龅赜蚓W(wǎng)關(guān)方向，且目的路由表 ID 為本地域下網(wǎng)絡(luò)實(shí)例的路由表 ID 時(shí)，目的路由表 ID 列表才會(huì)生效。
| |
| string | 否 | 路由需匹配的目的路由表 ID 列表。最多支持輸入 32 個(gè)路由表 ID。 說明
僅路由策略的應(yīng)用方向?yàn)槌龅赜蚓W(wǎng)關(guān)方向，且目的路由表 ID 為本地域下網(wǎng)絡(luò)實(shí)例的路由表 ID 時(shí)，目的路由表 ID 列表才會(huì)生效。
| vtb-adefrgtr144vf**** | |
| SourceRegionIds | array | 否 | 路由需匹配的源地域 ID 列表。最多支持輸入 32 個(gè)地域 ID。 您可以通過調(diào)用 DescribeChildInstanceRegions 接口獲取地域 ID。 | |
| string | 否 | 路由需匹配的源地域 ID 列表。最多支持輸入 32 個(gè)地域 ID。 您可以通過調(diào)用 DescribeChildInstanceRegions 接口獲取地域 ID。 | cn-beijing | |
| SourceChildInstanceTypes | array | 否 | 路由需匹配的源實(shí)例類型列表。支持以下實(shí)例類型：
支持輸入多種實(shí)例類型。 | |
| string | 否 | 路由需匹配的源實(shí)例類型列表。支持以下實(shí)例類型：
支持輸入多種實(shí)例類型。 | VPC | |
| DestinationChildInstanceTypes | array | 否 | 路由需匹配的目的實(shí)例類型列表。支持以下實(shí)例類型：
支持輸入多種實(shí)例類型。 說明
僅路由策略的應(yīng)用方向?yàn)槌龅赜蚓W(wǎng)關(guān)方向，且目的實(shí)例類型為本地域下的實(shí)例類型時(shí)，目的實(shí)例類型列表才會(huì)生效。
| |
| string | 否 | 路由需匹配的目的實(shí)例類型列表。支持以下實(shí)例類型：
支持輸入多種實(shí)例類型。 說明
僅路由策略的應(yīng)用方向?yàn)槌龅赜蚓W(wǎng)關(guān)方向，且目的實(shí)例類型為本地域下的實(shí)例類型時(shí)，目的實(shí)例類型列表才會(huì)生效。
| VPC | |
| DestinationCidrBlocks | array | 否 | 路由需匹配的前綴列表。 前綴列表中的 IP 地址段使用 CIDR 格式，最多支持輸入 32 個(gè) IP 地址段。 支持 IPv4、IPv6 格式。 | |
| string | 否 | 路由需匹配的前綴列表。 前綴列表中的 IP 地址段使用 CIDR 格式，最多支持輸入 32 個(gè) IP 地址段。 支持 IPv4、IPv6 格式。 | 10.10.10.0/24 | |
| RouteTypes | array | 否 | 路由需匹配的路由類型列表。支持以下路由類型：
支持輸入多種路由類型。 | |
| string | 否 | 路由需匹配的路由類型列表。支持以下路由類型：
支持輸入多種路由類型。 | System | |
| MatchAsns | array | 否 | 路由需匹配的 AS Path 列表。 最多支持輸入 32 個(gè) AS 號(hào)碼。 說明
僅支持 AS SEQUENCE，不支持 AS SET、AS CONFED SEQUENCE 和 AS CONFED SET，即只能是 AS 號(hào)列表，不支持集合和子列表。
| |
| long | 否 | 路由需匹配的 AS Path 列表。 最多支持輸入 32 個(gè) AS 號(hào)碼。 說明
僅支持 AS SEQUENCE，不支持 AS SET、AS CONFED SEQUENCE 和 AS CONFED SET，即只能是 AS 號(hào)列表，不支持集合和子列表。
| 65501 | |
| MatchCommunitySet | array | 否 | 路由需匹配的 Community 集合。 每個(gè) Community 格式為 n:m，n、m 的取值范圍為 1~65535。Community 需要符合 RFC 1997，不支持 Large Community（RFC 8092）。 最多支持輸入 32 個(gè) Community。 說明
Community 配置錯(cuò)誤可能會(huì)導(dǎo)致路由不能發(fā)布到本地?cái)?shù)據(jù)中心。
| |
| string | 否 | 路由需匹配的 Community 集合。 每個(gè) Community 格式為 n:m，n、m 的取值范圍為 1~65535。Community 需要符合 RFC 1997，不支持 Large Community（RFC 8092）。 最多支持輸入 32 個(gè) Community。 說明
Community 配置錯(cuò)誤可能會(huì)導(dǎo)致路由不能發(fā)布到本地?cái)?shù)據(jù)中心。
| 65501:1 | |
| OperateCommunitySet | array | 否 | 要執(zhí)行的 Community 集合。 每個(gè) Community 格式為 n:m，n、m 的取值范圍為 1~65535。Community 需要符合 RFC 1997，不支持 Large Communities（RFC 8092）。 最多支持輸入 32 個(gè) Community。 說明
Community 配置錯(cuò)誤可能會(huì)導(dǎo)致路由不能發(fā)布到本地?cái)?shù)據(jù)中心。
| |
| string | 否 | 要執(zhí)行的 Community 集合。 每個(gè) Community 格式為 n:m，n、m 的取值范圍為 1~65535。Community 需要符合 RFC 1997，不支持 Large Communities（RFC 8092）。 最多支持輸入 32 個(gè) Community。 說明
Community 配置錯(cuò)誤可能會(huì)導(dǎo)致路由不能發(fā)布到本地?cái)?shù)據(jù)中心。
| 65501:1 | |
| PrependAsPath | array | 否 | 地域網(wǎng)關(guān)接收或發(fā)布路由時(shí)附加的 AS Path。 路由策略應(yīng)用方向不同，配置附加 AS Path 的要求也不同，具體如下：
本參數(shù)表示路由通過匹配條件后，要執(zhí)行的操作。最多支持輸入 32 個(gè) AS 號(hào)碼。 | |
| long | 否 | 地域網(wǎng)關(guān)接收或發(fā)布路由時(shí)附加的 AS Path。 路由策略應(yīng)用方向不同，配置附加 AS Path 的要求也不同，具體如下：
本參數(shù)表示路由通過匹配條件后，要執(zhí)行的操作。最多支持輸入 32 個(gè) AS 號(hào)碼。 | 65501 | |
| DestinationRegionIds | array | 否 | 路由需匹配的目的地域 ID 列表。最多支持輸入 32 個(gè)地域 ID。 | |
| string | 否 | 路由需匹配的目的地域 ID 列表。最多支持輸入 32 個(gè)地域 ID。 | cn-beijing |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"RouteMapId": "cenrmap-w4yf7toozfol3q****",
"RequestId": "62172DD5-6BAC-45DF-8D44-56SDF467BAC"
}錯(cuò)誤碼
| HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
|---|---|---|---|
| 400 | Forbidden.CenRouteMapExist | The specified CEN route map ID already exists. | 路由策略已經(jīng)存在。 |
| 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不能在同一個(gè)地域。 |
| 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. | 轉(zhuǎn)發(fā)路由器狀態(tài)不正確。 |
| 400 | InvalidDescription | Description is invalid. | 描述不合法。 |
| 400 | IllegalParam.ZoneId | The specified ZoneId is illegal. | 傳入的可用區(qū)非法 |
| 400 | InvalidParameter | Invalid parameter. | 參數(shù)不合法。 |
| 400 | Unauthorized | The AccessKeyId is unauthorized. | 賬號(hào)無權(quán)限操作。 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-11-22 | OpenAPI 描述信息更新、OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-09-18 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
| 2024-09-10 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
| 2024-09-10 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
| 2023-12-13 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2022-07-19 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |