全部产品
Search
文档中心

云企业网:DescribeCenRouteMaps - 查询路由策略

更新时间:Mar 01, 2024

调用DescribeCenRouteMaps接口查询路由策略中已配置信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cen:DescribeCenRouteMapsRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
PageNumberinteger

列表的页码。默认值:1

1
PageSizeinteger

分页查询时每页显示的条目数。默认值:10

10
CenIdstring

云企业网实例 ID。

cen-wx12mmlt17ld82****
RouteMapIdstring

路由策略 ID。

cenrmap-y40mxdvf7joc12****
CenRegionIdstring

路由策略应用的地域 ID。

您可以通过调用 DescribeChildInstanceRegions 接口获取地域 ID。

cn-hangzhou
TransmitDirectionstring

路由策略的应用方向。取值:

  • RegionIn:入地域网关方向,表示路由传入云企业网地域网关的方向。

例如:路由从本地域的网络实例发布到本地域网关,或其他地域的路由发布到本地域网关。

  • RegionOut:出地域网关方向,表示路由传出云企业网地域网关的方向。

例如:路由从本地域网关发布到本地域下的网络实例,或发布到其他地域的地域网关。

RegionOut
TransitRouterRouteTableIdstring

路由策略关联的转发路由器路由表 ID。

vtb-gw8nx3515m1mbd1z1****

返回参数

名称类型描述示例值
object

返回结果。

PageSizeinteger

分页查询时每页显示的条目数。

10
RequestIdstring

请求 ID。

24CE1987-D1D1-5324-9BAD-2750B60E6ABB
PageNumberinteger

列表的页码。

1
TotalCountinteger

列表条目数。

1
RouteMapsobject []

路由策略信息列表。

RouteMapIdstring

路由策略 ID。

cenrmap-y40mxdvf7joc12****
Statusstring

路由策略的状态。

  • Creating:创建中。
  • Active:可用。
  • Deleting:删除中。
Active
TransmitDirectionstring

路由策略的应用方向。

RegionOut
SourceInstanceIdsReverseMatchboolean

是否使用了源实例 ID 列表的排除匹配模式。

  • false:否,即路由传递的源实例 ID 在SourceInstanceIds.N中时,匹配通过。

  • true:是,即路由传递的源实例 ID 不在SourceInstanceIds.N中时,匹配通过。

false
CenRegionIdstring

路由策略应用的地域 ID。

cn-hangzhou
CenIdstring

云企业网实例 ID。

cen-wx12mmlt17ld82****
Priorityinteger

路由策略的优先级。优先级数字越小,代表优先级越高。

5000
TransitRouterRouteTableIdstring

路由策略关联的转发路由器路由表 ID。

vtb-gw8nx3515m1mbd1z1****
CommunityOperateModestring

Community 的执行模式。

  • Additive:添加,表示为路由添加 Community。

  • Replace:替换,表示替换路由原有的 Community。

本参数表示路由通过匹配条件后,要执行的操作。

Additive
MapResultstring

所有匹配条件都通过后的策略行为。

  • Permit:允许被匹配的路由通过。

  • Deny:拒绝被匹配的路由通过。

Deny
CommunityMatchModestring

Community 的匹配模式。

  • Include:模糊匹配,匹配条件中的 Community 与被匹配路由的 Community 有重叠即判定为匹配成功。

  • Complete:精确匹配,匹配条件中的 Community 必须与被匹配路由的 Community 一致,才判定为匹配成功。

Include
Descriptionstring

路由策略的描述信息。

desctest
AsPathMatchModestring

AS Path 列表的匹配模式。

  • Include:模糊匹配,匹配条件中的 AS Path 与被匹配路由的 AS Path 有重叠即判定为匹配成功。

  • Complete:精确匹配,匹配条件中的 AS Path 必须与被匹配路由的 AS Path 一致,才判定为匹配成功。

Include
Preferenceinteger

要修改的路由的优先级。

优先级数字越小表示优先级越高。

本参数表示路由通过匹配条件后,要执行的操作。

20
DestinationInstanceIdsReverseMatchboolean

是否使用了目的实例 ID 列表的排除匹配模式。

  • false:否,即路由传递的目的实例 ID 在DestinationInstanceIds.N中时,匹配通过。

  • true:是,即路由传递的目的实例 ID 不在DestinationInstanceIds.N中时,匹配通过。

false
CidrMatchModestring

前缀列表的匹配模式。取值:

  • Include:模糊匹配。匹配条件中的路由前缀包含被匹配路由的路由前缀即判定为匹配成功。

例如:定义 10.10.0.0/16 的策略可以模糊匹配到 10.10.1.0/24 的路由。

  • Complete:精确匹配。匹配条件中的路由前缀必须与被匹配路由的路由前缀一致,才判定为匹配成功。

例如:定义 10.10.0.0/16 的策略仅可以精确匹配到 10.10.0.0/16 的路由。

Include
NextPriorityinteger

关联的下一条路由策略的优先级。

33
MatchAddressTypestring

路由需匹配的 IP 地址类型。

  • IPv4:表示只匹配 IPv4 路由。
  • IPv6:表示只匹配 IPv6 路由。
  • 如果系统未返回该值,则表示同时匹配 IPv4 和 IPv6 的路由。
IPv4
SourceRegionIdsarray

路由需匹配的源地域 ID 列表。

string

路由需匹配的源地域 ID 列表。

cn-hangzhou
SourceChildInstanceTypesarray

路由需匹配的源实例类型列表。

  • VPC:专有网络实例。

  • VBR:边界路由器实例。

  • CCN:云连接网实例。

  • VPN:IPsec 连接。

string

路由需匹配的源实例类型列表。

  • VPC:专有网络实例。

  • VBR:边界路由器实例。

  • CCN:云连接网实例。

  • VPN:IPsec 连接。

VPC
DestinationRouteTableIdsarray

路由需匹配的目的路由表 ID 列表。最多支持输入 32 个路由表 ID。

说明 仅路由策略的应用方向为出地域网关方向,且目的路由表 ID 为本地域下网络实例的路由表 ID 时,目的路由表 ID 列表才会生效。
string

路由需匹配的目的路由表 ID 列表。最多支持输入 32 个路由表 ID。

说明 仅路由策略的应用方向为出地域网关方向,且目的路由表 ID 为本地域下网络实例的路由表 ID 时,目的路由表 ID 列表才会生效。
vtb-adefrgtr144vf****
SourceInstanceIdsarray

路由需匹配的源实例 ID 列表。

string

路由需匹配的源实例 ID 列表。

vpc-adeg3544fdf34vf****
DestinationCidrBlocksarray

路由需匹配的前缀列表。

string

路由需匹配的前缀列表。

10.10.10.0/24
SourceRouteTableIdsarray

路由需匹配的源路由表 ID 列表。

string

路由需匹配的源路由表 ID 列表。

vtb-adfr233vf34rvd4****
MatchCommunitySetarray

路由需匹配的 Community 集合。

string

路由需匹配的 Community 集合。

65501:1
PrependAsPatharray

地域网关接收或发布路由时附加的 AS Path。

本参数表示路由通过匹配条件后,要执行的操作。

string

地域网关接收或发布路由时附加的 AS Path。

本参数表示路由通过匹配条件后,要执行的操作。

65501
RouteTypesarray

路由需匹配的路由类型列表。

  • System:系统路由,由系统自动生成的路由。

  • Custom:自定义路由,由用户手动添加的路由。

  • BGP:BGP 路由,通过 BGP 路由协议传播的路由。

string

路由需匹配的路由类型列表。

  • System:系统路由,由系统自动生成的路由。

  • Custom:自定义路由,由用户手动添加的路由。

  • BGP:BGP 路由,通过 BGP 路由协议传播的路由。

System
DestinationChildInstanceTypesarray

路由需匹配的目的实例类型列表。

  • VPC:专有网络实例。

  • VBR:边界路由器实例。

  • CCN:云连接网实例。

  • VPN:IPsec 连接。

说明 仅路由策略的应用方向为出地域网关方向,且目的实例类型为本地域下的实例类型时,目的实例类型列表才会生效。
string

路由需匹配的目的实例类型列表。

  • VPC:专有网络实例。

  • VBR:边界路由器实例。

  • CCN:云连接网实例。

  • VPN:IPsec 连接。

说明 仅路由策略的应用方向为出地域网关方向,且目的实例类型为本地域下的实例类型时,目的实例类型列表才会生效。
VPC
DestinationInstanceIdsarray

路由需匹配的目的实例 ID 列表。

说明 仅路由策略的应用方向为出地域网关方向,且目的实例 ID 为本地域下的实例 ID 时,目的实例 ID 列表才会生效。
string

路由需匹配的目的实例 ID 列表。

说明 仅路由策略的应用方向为出地域网关方向,且目的实例 ID 为本地域下的实例 ID 时,目的实例 ID 列表才会生效。
vpc-afrfs434465fdf****
MatchAsnsarray

路由需匹配的 AS Path 列表。

string

路由需匹配的 AS Path 列表。

65501
OperateCommunitySetarray

要执行的 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"
          ]
        },
        "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错误码错误信息描述
400InvalidParameterInvalid parameter.参数不合法。
400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史