使用DescribeCenRouteMaps查詢路由策略-雲企業網-阿里雲

調用DescribeCenRouteMaps介面查詢路由策略中已配置資訊。

介面說明

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

cen:DescribeCenRouteMaps

get

*CenInstance

acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}

無

請求參數

名稱	類型	必填	描述	樣本值
PageNumber	integer	否	列表的頁碼。預設值：1。	1
PageSize	integer	否	分頁查詢時每頁顯示的條目數。預設值：10。	10
CenId	string	是	雲企業網執行個體 ID。	cen-wx12mmlt17ld82****
RouteMapId	string	否	路由策略 ID。	cenrmap-y40mxdvf7joc12****
CenRegionId	string	否	路由策略應用的地區 ID。您可以通過調用 DescribeChildInstanceRegions 介面擷取地區 ID。	cn-hangzhou
TransmitDirection	string	否	路由策略的應用方向。取值： RegionIn：入地區網關方向，表示路由傳入雲企業網地區網關的方向。例如：路由從本地區的網路執行個體發布到本地區網關，或其他地區的路由發布到本地區網關。 RegionOut：出地區網關方向，表示路由傳出雲企業網地區網關的方向。例如：路由從本地區網關發布到本地區下的網路執行個體，或發布到其他地區的地區網關。	RegionOut
TransitRouterRouteTableId	string	否	路由策略關聯的轉寄路由器路由表 ID。	vtb-gw8nx3515m1mbd1z1****

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
PageSize	integer	分頁查詢時每頁顯示的條目數。	10
RequestId	string	請求 ID。	24CE1987-D1D1-5324-9BAD-2750B60E6ABB
PageNumber	integer	列表的頁碼。	1
TotalCount	integer	列表條目數。	1
RouteMaps	object
RouteMap	array<object>	路由策略資訊列表。
	object	路由策略的資訊。
RouteMapId	string	路由策略 ID。	cenrmap-y40mxdvf7joc12****
Status	string	路由策略的狀態。 Creating：建立中。 Active：可用。 Deleting：刪除中。	Active
TransmitDirection	string	路由策略的應用方向。	RegionOut
SourceInstanceIdsReverseMatch	boolean	是否使用了源執行個體 ID 列表的排除匹配模式。 false：否，即路由傳遞的源執行個體 ID 在SourceInstanceIds.N中時，匹配通過。 true：是，即路由傳遞的源執行個體 ID 不在SourceInstanceIds.N中時，匹配通過。	false
CenRegionId	string	路由策略應用的地區 ID。	cn-hangzhou
CenId	string	雲企業網執行個體 ID。	cen-wx12mmlt17ld82****
Priority	integer	路由策略的優先順序。優先順序數字越小，代表優先順序越高。	5000
TransitRouterRouteTableId	string	路由策略關聯的轉寄路由器路由表 ID。	vtb-gw8nx3515m1mbd1z1****
CommunityOperateMode	string	Community 的執行模式。 Additive：添加，表示為路由添加 Community。 Replace：替換，表示替換路由原有的 Community。本參數表示路由通過匹配條件後，要執行的操作。	Additive
MapResult	string	所有匹配條件都通過後的策略行為。 Permit：允許被匹配的路由通過。 Deny：拒絕被匹配的路由通過。	Deny
CommunityMatchMode	string	Community 的匹配模式。 Include：模糊比對，匹配條件中的 Community 與被匹配路由的 Community 有重疊即判定為匹配成功。 Complete：精確匹配，匹配條件中的 Community 必須與被匹配路由的 Community 一致，才判定為匹配成功。	Include
Description	string	路由策略的描述資訊。	desctest
AsPathMatchMode	string	AS Path 列表的匹配模式。 Include：模糊比對，匹配條件中的 AS Path 與被匹配路由的 AS Path 有重疊即判定為匹配成功。 Complete：精確匹配，匹配條件中的 AS Path 必須與被匹配路由的 AS Path 一致，才判定為匹配成功。	Include
Preference	integer	要修改的路由的優先順序。優先順序數字越小表示優先順序越高。本參數表示路由通過匹配條件後，要執行的操作。	20
DestinationInstanceIdsReverseMatch	boolean	是否使用了目的執行個體 ID 列表的排除匹配模式。 false：否，即路由傳遞的目的執行個體 ID 在DestinationInstanceIds.N中時，匹配通過。 true：是，即路由傳遞的目的執行個體 ID 不在DestinationInstanceIds.N中時，匹配通過。	false
CidrMatchMode	string	首碼列表的匹配模式。取值： Include：模糊比對。匹配條件中的路由首碼包含被匹配路由的路由首碼即判定為匹配成功。例如：定義 10.10.0.0/16 的策略可以模糊比對到 10.10.1.0/24 的路由。 Complete：精確匹配。匹配條件中的路由首碼必須與被匹配路由的路由首碼一致，才判定為匹配成功。例如：定義 10.10.0.0/16 的策略僅可以精確匹配到 10.10.0.0/16 的路由。	Include
NextPriority	integer	關聯的下一條路由策略的優先順序。	33
MatchAddressType	string	路由需匹配的 IP 位址類型。 IPv4：表示只匹配 IPv4 路由。 IPv6：表示只匹配 IPv6 路由。如果系統未返回該值，則表示同時匹配 IPv4 和 IPv6 的路由。	IPv4
SourceRegionIds	object
SourceRegionId	array	路由需匹配的源地區 ID 列表。
	string	路由需匹配的源地區 ID 列表。	cn-hangzhou
SourceChildInstanceTypes	object
SourceChildInstanceType	array	路由需匹配的源執行個體類型列表。 VPC：專用網路執行個體。 VBR：邊界路由器執行個體。 CCN：雲串連網執行個體。 VPN：IPsec 串連。
	string	路由需匹配的源執行個體類型列表。 VPC：專用網路執行個體。 VBR：邊界路由器執行個體。 CCN：雲串連網執行個體。 VPN：IPsec 串連。	VPC
DestinationRouteTableIds	object
DestinationRouteTableId	array	路由需匹配的目的路由表 ID 列表。最多支援輸入 32 個路由表 ID。說明僅路由策略的應用方向為出地區網關方向，且目的路由表 ID 為本地區下網路執行個體的路由表 ID 時，目的路由表 ID 列表才會生效。
	string	路由需匹配的目的路由表 ID 列表。最多支援輸入 32 個路由表 ID。說明僅路由策略的應用方向為出地區網關方向，且目的路由表 ID 為本地區下網路執行個體的路由表 ID 時，目的路由表 ID 列表才會生效。	vtb-adefrgtr144vf****
SourceInstanceIds	object
SourceInstanceId	array	路由需匹配的源執行個體 ID 列表。
	string	路由需匹配的源執行個體 ID 列表。	vpc-adeg3544fdf34vf****
DestinationCidrBlocks	object
DestinationCidrBlock	array	路由需匹配的首碼列表。支援 IPv4、IPv6 格式。
	string	路由需匹配的首碼列表。支援 IPv4、IPv6 格式。	10.10.10.0/24
DestinationRegionIds	object
DestinationRegionId	array	路由策略的目標地區 ID 列表。
	string	路由策略的目標地區 ID 列表。	cn-beijing
SourceRouteTableIds	object
SourceRouteTableId	array	路由需匹配的源路由表 ID 列表。
	string	路由需匹配的源路由表 ID 列表。	vtb-adfr233vf34rvd4****
MatchCommunitySet	object
MatchCommunity	array	路由需匹配的 Community 集合。
	string	路由需匹配的 Community 集合。	65501:1
PrependAsPath	object
AsPath	array	地區網關接收或發布路由時附加的 AS Path。本參數表示路由通過匹配條件後，要執行的操作。
	string	地區網關接收或發布路由時附加的 AS Path。本參數表示路由通過匹配條件後，要執行的操作。	65501
RouteTypes	object
RouteType	array	路由需匹配的路由類型列表。 System：系統路由，由系統自動產生的路由。 Custom：自訂路由，由使用者手動添加的路由。 BGP：BGP 路由，通過 BGP 路由協議傳播的路由。
	string	路由需匹配的路由類型列表。 System：系統路由，由系統自動產生的路由。 Custom：自訂路由，由使用者手動添加的路由。 BGP：BGP 路由，通過 BGP 路由協議傳播的路由。	System
DestinationChildInstanceTypes	object
DestinationChildInstanceType	array	路由需匹配的目的執行個體類型列表。 VPC：專用網路執行個體。 VBR：邊界路由器執行個體。 CCN：雲串連網執行個體。 VPN：IPsec 串連。說明僅路由策略的應用方向為出地區網關方向，且目的執行個體類型為本地區下的執行個體類型時，目的執行個體類型列表才會生效。
	string	路由需匹配的目的執行個體類型列表。 VPC：專用網路執行個體。 VBR：邊界路由器執行個體。 CCN：雲串連網執行個體。 VPN：IPsec 串連。說明僅路由策略的應用方向為出地區網關方向，且目的執行個體類型為本地區下的執行個體類型時，目的執行個體類型列表才會生效。	VPC
DestinationInstanceIds	object
DestinationInstanceId	array	路由需匹配的目的執行個體 ID 列表。說明僅路由策略的應用方向為出地區網關方向，且目的執行個體 ID 為本地區下的執行個體 ID 時，目的執行個體 ID 列表才會生效。
	string	路由需匹配的目的執行個體 ID 列表。說明僅路由策略的應用方向為出地區網關方向，且目的執行個體 ID 為本地區下的執行個體 ID 時，目的執行個體 ID 列表才會生效。	vpc-afrfs434465fdf****
MatchAsns	object
MatchAsn	array	路由需匹配的 AS Path 列表。
	string	路由需匹配的 AS Path 列表。	65501
OperateCommunitySet	object
OperateCommunity	array	要執行的 Community 集合。
	string	要執行的 Community 集合。	65501:1

樣本

正常返回樣本

JSON格式

{
  "PageSize": 10,
  "RequestId": "24CE1987-D1D1-5324-9BAD-2750B60E6ABB",
  "PageNumber": 1,
  "TotalCount": 1,
  "RouteMaps": {
    "RouteMap": [
      {
        "RouteMapId": "cenrmap-y40mxdvf7joc12****",
        "Status": "Active",
        "TransmitDirection": "RegionOut",
        "SourceInstanceIdsReverseMatch": false,
        "CenRegionId": "cn-hangzhou",
        "CenId": "cen-wx12mmlt17ld82****",
        "Priority": 5000,
        "TransitRouterRouteTableId": "vtb-gw8nx3515m1mbd1z1****",
        "CommunityOperateMode": "Additive",
        "MapResult": "Deny",
        "CommunityMatchMode": "Include",
        "Description": "desctest",
        "AsPathMatchMode": "Include",
        "Preference": 20,
        "DestinationInstanceIdsReverseMatch": false,
        "CidrMatchMode": "Include",
        "NextPriority": 33,
        "MatchAddressType": "IPv4",
        "SourceRegionIds": {
          "SourceRegionId": [
            "cn-hangzhou"
          ]
        },
        "SourceChildInstanceTypes": {
          "SourceChildInstanceType": [
            "VPC"
          ]
        },
        "DestinationRouteTableIds": {
          "DestinationRouteTableId": [
            "vtb-adefrgtr144vf****"
          ]
        },
        "SourceInstanceIds": {
          "SourceInstanceId": [
            "vpc-adeg3544fdf34vf****"
          ]
        },
        "DestinationCidrBlocks": {
          "DestinationCidrBlock": [
            "10.10.10.0/24"
          ]
        },
        "DestinationRegionIds": {
          "DestinationRegionId": [
            "cn-beijing"
          ]
        },
        "SourceRouteTableIds": {
          "SourceRouteTableId": [
            "vtb-adfr233vf34rvd4****"
          ]
        },
        "MatchCommunitySet": {
          "MatchCommunity": [
            "65501:1"
          ]
        },
        "PrependAsPath": {
          "AsPath": [
            "65501"
          ]
        },
        "RouteTypes": {
          "RouteType": [
            "System"
          ]
        },
        "DestinationChildInstanceTypes": {
          "DestinationChildInstanceType": [
            "VPC"
          ]
        },
        "DestinationInstanceIds": {
          "DestinationInstanceId": [
            "vpc-afrfs434465fdf****"
          ]
        },
        "MatchAsns": {
          "MatchAsn": [
            "65501"
          ]
        },
        "OperateCommunitySet": {
          "OperateCommunity": [
            "65501:1"
          ]
        }
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidParameter	Invalid parameter.	參數不合法。
400	Unauthorized	The AccessKeyId is unauthorized.	帳號無許可權操作。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。