通過路由策略功能,可以過濾路由資訊,協助您自訂管理雲上網路互連能力,您可以調用CreateCenRouteMap介面建立路由策略。
介面說明
路由策略按照優先順序進行排列,優先順序數字越小,優先順序越高。每條路由策略都是條件陳述式和執行語句的集合。執行路由策略時,路由從優先順序最高的路由策略開始匹配條件陳述式,對於符合全部匹配條件的路由,路由策略將按照策略行為允許路由通過或拒絕路由通過,允許通過的路由支援修改路由屬性;對於不符合全部匹配條件的路由,系統預設允許路由通過。更多資訊,請參見路由策略概述。
CreateCenRouteMap介面屬於非同步介面,即系統會先返回一個路由策略 ID,但該路由策略並未建立完成,系統背景建立任務仍在進行。您可以調用DescribeCenRouteMaps介面查詢路由策略的狀態。
當路由策略處於 Creating 狀態時,表示路由策略正在建立中,在該狀態下,您只能執行查詢操作,不能執行其他動作。
當路由策略處於 Active 狀態時,表示路由策略建立完成。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
cen:CreateCenRouteMap |
create |
*CenInstance
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| 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:
最多支援輸入 64 個執行個體 ID。 |
vpc-adeg3544fdf34vf**** |
|
string |
否 |
路由需匹配的源執行個體 ID 列表。支援輸入以下類型的執行個體 ID:
最多支援輸入 64 個執行個體 ID。 |
vpc-adeg3544fdf34vf**** |
|
| DestinationInstanceIds |
array |
否 |
路由需匹配的目的執行個體 ID 列表。支援輸入以下類型的執行個體 ID:
最多支援輸入 64 個執行個體 ID。 說明
僅路由策略的應用方向為出地區網關方向,且目的執行個體 ID 為本地區下的執行個體 ID 時,目的執行個體 ID 列表才會生效。 |
vpc-afrfs434465fdf**** |
|
string |
否 |
路由需匹配的目的執行個體 ID 列表。支援輸入以下類型的執行個體 ID:
最多支援輸入 64 個執行個體 ID。 說明
僅路由策略的應用方向為出地區網關方向,且目的執行個體 ID 為本地區下的執行個體 ID 時,目的執行個體 ID 列表才會生效。 |
vpc-afrfs434465fdf**** |
|
| SourceRouteTableIds |
array |
否 |
路由需匹配的源路由表 ID 列表。最多支援輸入 64 個路由表 ID。 |
vtb-adfr233vf34rvd4**** |
|
string |
否 |
路由需匹配的源路由表 ID 列表。最多支援輸入 64 個路由表 ID。 |
vtb-adfr233vf34rvd4**** |
|
| DestinationRouteTableIds |
array |
否 |
路由需匹配的目的路由表 ID 列表。最多支援輸入 64 個路由表 ID。 說明
僅路由策略的應用方向為出地區網關方向,且目的路由表 ID 為本地區下網路執行個體的路由表 ID 時,目的路由表 ID 列表才會生效。 |
vtb-adefrgtr144vf**** |
|
string |
否 |
路由需匹配的目的路由表 ID 列表。最多支援輸入 64 個路由表 ID。 說明
僅路由策略的應用方向為出地區網關方向,且目的路由表 ID 為本地區下網路執行個體的路由表 ID 時,目的路由表 ID 列表才會生效。 |
vtb-adefrgtr144vf**** |
|
| SourceRegionIds |
array |
否 |
路由需匹配的源地區 ID 列表。最多支援輸入 64 個地區 ID。 您可以通過調用 DescribeChildInstanceRegions 介面擷取地區 ID。 |
cn-beijing |
|
string |
否 |
路由需匹配的源地區 ID 列表。最多支援輸入 64 個地區 ID。 您可以通過調用 DescribeChildInstanceRegions 介面擷取地區 ID。 |
cn-beijing |
|
| SourceChildInstanceTypes |
array |
否 |
路由需匹配的源執行個體類型列表。支援以下執行個體類型:
支援輸入多種執行個體類型。 |
VPC |
|
string |
否 |
路由需匹配的源執行個體類型列表。支援以下執行個體類型:
支援輸入多種執行個體類型。 |
VPC |
|
| DestinationChildInstanceTypes |
array |
否 |
路由需匹配的目的執行個體類型列表。支援以下執行個體類型:
支援輸入多種執行個體類型。 說明
僅路由策略的應用方向為出地區網關方向,且目的執行個體類型為本地區下的執行個體類型時,目的執行個體類型列表才會生效。 |
VPC |
|
string |
否 |
路由需匹配的目的執行個體類型列表。支援以下執行個體類型:
支援輸入多種執行個體類型。 說明
僅路由策略的應用方向為出地區網關方向,且目的執行個體類型為本地區下的執行個體類型時,目的執行個體類型列表才會生效。 |
VPC |
|
| DestinationCidrBlocks |
array |
否 |
路由需匹配的首碼列表。 首碼列表中的 IP 位址段使用 CIDR 格式,最多支援輸入 64 個 IP 位址段。 支援 IPv4、IPv6 格式。 |
10.10.10.0/24 |
|
string |
否 |
路由需匹配的首碼列表。 首碼列表中的 IP 位址段使用 CIDR 格式,最多支援輸入 64 個 IP 位址段。 支援 IPv4、IPv6 格式。 |
10.10.10.0/24 |
|
| RouteTypes |
array |
否 |
路由需匹配的路由類型列表。支援以下路由類型:
支援輸入多種路由類型。 |
System |
|
string |
否 |
路由需匹配的路由類型列表。支援以下路由類型:
支援輸入多種路由類型。 |
System |
|
| MatchAsns |
array |
否 |
路由需匹配的 AS Path 列表。 最多支援輸入 64 個 AS 號碼。 說明
僅支援 AS SEQUENCE,不支援 AS SET、AS CONFED SEQUENCE 和 AS CONFED SET,即只能是 AS 號列表,不支援集合和子列表。 |
65501 |
|
integer |
否 |
路由需匹配的 AS Path 列表。 最多支援輸入 64 個 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)。 最多支援輸入 64 個 Community。 說明
Community 配置錯誤可能會導致路由不能發布到本機資料中心。 |
65501:1 |
|
string |
否 |
路由需匹配的 Community 集合。 每個 Community 格式為 n:m,n、m 的取值範圍為 1~65535。Community 需要符合 RFC 1997,不支援 Large Community(RFC 8092)。 最多支援輸入 64 個 Community。 說明
Community 配置錯誤可能會導致路由不能發布到本機資料中心。 |
65501:1 |
|
| OperateCommunitySet |
array |
否 |
要執行的 Community 集合。 每個 Community 格式為 n:m,n、m 的取值範圍為 1~65535。Community 需要符合 RFC 1997,不支援 Large Communities(RFC 8092)。 最多支援輸入 32 個 Community。 說明
Community 配置錯誤可能會導致路由不能發布到本機資料中心。 |
65501:1 |
|
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 號碼。 |
65501 |
|
integer |
否 |
地區網關接收或發布路由時附加的 AS Path。 路由策略應用方向不同,配置附加 AS Path 的要求也不同,具體如下:
本參數表示路由通過匹配條件後,要執行的操作。最多支援輸入 32 個 AS 號碼。 |
65501 |
|
| DestinationRegionIds |
array |
否 |
路由需匹配的目的地區 ID 列表。最多支援輸入 64 個地區 ID。 |
|
|
string |
否 |
路由需匹配的目的地區 ID 列表。最多支援輸入 64 個地區 ID。 |
cn-beijing |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回結果。 |
||
| RouteMapId |
string |
路由策略的 ID。 |
cenrmap-w4yf7toozfol3q**** |
| RequestId |
string |
請求 ID。 |
62172DD5-6BAC-45DF-8D44-56SDF467BAC |
樣本
正常返回樣本
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 | IncorrectStatus.TransitRouterInstance | The status of TransitRouter is incorrect. | 轉寄路由器狀態不正確。 |
| 400 | InvalidDescription | Description is invalid. | 描述不合法。 |
| 400 | IllegalParam.ZoneId | The specified ZoneId is illegal. | 傳入的可用性區域非法 |
| 400 | Forbidden.NoMedAuthorized | Med operation is unauthorized. | 無法對指定的Med路由策略進行操作。 |
| 400 | InvalidOperation.MedRouteMapExist | Operation is invalid because the default med route map already exist. | 操作無效,因為已存在下一跳目的為該Ecr執行個體的med routeMap。 |
| 400 | InvalidOperation.MedRouteMapNotAllowedOtherAction | Operation is invalid because the default med not allowed other action. | 配置med策略的routeMap不允許配置其它策略。 |
| 400 | InvalidOperation.MedRouteMapActionMustPermit | Operation is invalid because the default med map result must be permit. | 操作無效,med routeMap的策略行為必須是允許。 |
| 400 | InvalidParameter.MedRouteMapDestInstanceIds | Param DestInstanceIds must be ecr instance id. | med routeMap的目的執行個體列表必須是ecr執行個體。 |
| 400 | InvalidParameter.MedRouteMapDestInstanceType | Param DestChildInstanceTypes must be ecr. | med routeMap的目的執行個體類型必須是ECR。 |
| 400 | InvalidParameter | Invalid parameter. | 參數不合法。 |
| 400 | Unauthorized | The AccessKeyId is unauthorized. | 帳號無許可權操作。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。