ListRouteMapRules - 查询路由策略规则-云企业网(CEN)-阿里云帮助中心

查询一个或多个路由策略规则的详细信息。

接口说明

请求说明

RouteMapId：指定要查询的路由策略下的规则。
RouteMapRuleIds：要查询的规则 ID 列表，与过滤条件可以同时匹配查询，是或的关系。
Filter：过滤器，可根据方向等属性进行筛选。支持的过滤条件包括 Status、Direction 等。
DryRun：是否为预运行模式，默认为 false。

RouteMapId和RouteMapRuleIds至少需要指定一个。如果同时提供，则会根据这两个参数进行联合查询；如果只提供RouteMapId，则返回该路由策略下的所有规则；如果只提供RouteMapRuleIds，则返回这些规则的详细信息。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cen:ListRouteMapRules

list

RouteMapRule

acs:cen:*:{#accountId}:routemaprule/*

RouteMap

acs:cen:*:{#accountId}:routemap/{#RouteMapId}

无

请求语法

GET / HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
ClientToken	string	否	客户端 Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。说明若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。	02fb3da4-130e-11e9-8e44-001****
RouteMapId	string	否	要查询的路由映射策略 ID。	rm-0a1b2c3d4e5f6a7b8
RouteMapRuleIds	array	否	要查询的路由策略规则 ID 列表。与过滤条件可以同时匹配查询，是与的关系。
	string	否	要查询的路由策略规则 ID 列表。与过滤条件可以同时匹配查询，是与的关系。	rmr-0a1b2c3d4e5f6a7b8
Filter	array<object>	否	过滤条件的信息。一次最多支持输入 5 个过滤条件。
	object	否	过滤条件的信息。一次最多支持输入 5 个过滤条件。
Key	string	否	过滤条件。取值： Name：路由策略规则的名称。 Priority：路由策略规则的优先级。多个过滤条件之间默认是与的关系，即必须符合所有过滤条件，才视为匹配过滤条件。一次最多支持输入 5 个过滤条件。	Name
Value	array	否	过滤条件的值。根据 Key 指定过滤值。一个 Key 支持指定多个过滤值，多个过滤值之间是或的关系，即只要符合其中一个过滤值，则视为匹配该过滤条件。一个过滤条件最多支持输入 5 个过滤值。
	string	否	过滤条件的值。根据 Key 指定过滤值。一个 Key 支持指定多个过滤值，多个过滤值之间是或的关系，即只要符合其中一个过滤值，则视为匹配该过滤条件。一个过滤条件最多支持输入 5 个过滤值。	test
DryRun	boolean	否	是否只预检此次请求。取值： true：发送检查请求，不会查询路由策略规则。检查项包括是否填写了必需参数、请求格式、业务限制等。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。 false（默认值）：发送正常请求，通过检查后直接查询路由策略规则。
MaxResults	integer	否	分批次查询时，每次显示的条目数。	20
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。	dd20****

返回参数

名称	类型	描述	示例值
	object	返回结果。
TotalCount	integer	列表条目数。	2
RequestId	string	请求 ID。	EF44D7B7-6248-5A60-8A4C-A92388605A57
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。	dd20****
MaxResults	integer	分批次查询时每次显示的条目数。	20
RouteMapRules	array<object>	路由策略规则信息列表。
	array<object>	路由策略规则的信息。
Description	string	规则的描述信息。	Matches production prefixes from on-prem and sets a higher local preference.
MatchConditions	object	路由策略规则的匹配条件。路由需要满足本参数中定义的全部匹配条件，系统才会执行 SetActions 中定义的动作。
AddressPrefixesInclude	array	路由需模糊匹配的路由前缀列表。匹配条件中的路由前缀包含被匹配路由的路由前缀即判定为匹配成功。例如：定义 10.0.0.0/8 的策略可以模糊匹配到 10.10.10.0/24 的路由。 IP 地址段使用 CIDR 格式，支持 IPv4、IPv6。本参数与 AddressPrefixesMatch 互斥，不能同时指定。
	string	路由需模糊匹配的路由前缀列表。匹配条件中的路由前缀包含被匹配路由的路由前缀即判定为匹配成功。例如：定义 10.0.0.0/8 的策略可以模糊匹配到 10.10.10.0/24 的路由。 IP 地址段使用 CIDR 格式，支持 IPv4、IPv6。本参数与 AddressPrefixesMatch 互斥，不能同时指定。	10.0.0.0/8
AddressPrefixesMatch	array	路由需精确匹配的路由前缀列表。匹配条件中的路由前缀必须与被匹配路由的路由前缀一致，才判定为匹配成功。例如：定义 10.0.0.0/8 的策略仅可以精确匹配到 10.0.0.0/8 的路由。 IP 地址段使用 CIDR 格式，支持 IPv4、IPv6。本参数与 AddressPrefixesInclude 互斥，不能同时指定。
	string	路由需精确匹配的路由前缀列表。匹配条件中的路由前缀必须与被匹配路由的路由前缀一致，才判定为匹配成功。例如：定义 10.0.0.0/8 的策略仅可以精确匹配到 10.0.0.0/8 的路由。 IP 地址段使用 CIDR 格式，支持 IPv4、IPv6。本参数与 AddressPrefixesInclude 互斥，不能同时指定。	10.0.0.0/8
AsPathsInclude	array	路由需模糊匹配的 AS Path 列表。匹配条件中的 AS Path 与被匹配路由的 AS Path 有重叠即判定为匹配成功。本参数与 AsPathsMatch 互斥，不能同时指定。说明仅支持 AS SEQUENCE，不支持 AS SET、AS CONFED SEQUENCE 和 AS CONFED SET，即只能是 AS 号列表，不支持集合和子列表。
	integer	路由需模糊匹配的 AS Path 列表。匹配条件中的 AS Path 与被匹配路由的 AS Path 有重叠即判定为匹配成功。本参数与 AsPathsMatch 互斥，不能同时指定。说明仅支持 AS SEQUENCE，不支持 AS SET、AS CONFED SEQUENCE 和 AS CONFED SET，即只能是 AS 号列表，不支持集合和子列表。	65000
AsPathsMatch	array	路由需精确匹配的 AS Path 列表。匹配条件中的 AS Path 必须与被匹配路由的 AS Path 一致，才判定为匹配成功。本参数与 AsPathsInclude 互斥，不能同时指定。说明仅支持 AS SEQUENCE，不支持 AS SET、AS CONFED SEQUENCE 和 AS CONFED SET，即只能是 AS 号列表，不支持集合和子列表。
	integer	路由需精确匹配的 AS Path 列表。匹配条件中的 AS Path 必须与被匹配路由的 AS Path 一致，才判定为匹配成功。本参数与 AsPathsInclude 互斥，不能同时指定。说明仅支持 AS SEQUENCE，不支持 AS SET、AS CONFED SEQUENCE 和 AS CONFED SET，即只能是 AS 号列表，不支持集合和子列表。	65000
CommunitySetInclude	array	路由需模糊匹配的 Community 集合。匹配条件中的 Community 与被匹配路由的 Community 有重叠即判定为匹配成功。每个 Community 格式为 n:m，n、m 的取值范围为 1~65535。Community 需要符合 RFC 1997，不支持 Large Community（RFC 8092）。本参数与 CommunitySetMatch 互斥，不能同时指定。说明 Community 配置错误可能会导致路由不能发布到本地数据中心。
	string	路由需模糊匹配的 Community 集合。匹配条件中的 Community 与被匹配路由的 Community 有重叠即判定为匹配成功。每个 Community 格式为 n:m，n、m 的取值范围为 1~65535。Community 需要符合 RFC 1997，不支持 Large Community（RFC 8092）。本参数与 CommunitySetMatch 互斥，不能同时指定。说明 Community 配置错误可能会导致路由不能发布到本地数据中心。	65000:100
CommunitySetMatch	array	路由需精确匹配的 Community 集合。匹配条件中的 Community 必须与被匹配路由的 Community 一致，才判定为匹配成功。每个 Community 格式为 n:m，n、m 的取值范围为 1~65535。Community 需要符合 RFC 1997，不支持 Large Community（RFC 8092）。本参数与 CommunitySetInclude 互斥，不能同时指定。说明 Community 配置错误可能会导致路由不能发布到本地数据中心。
	string	路由需精确匹配的 Community 集合。匹配条件中的 Community 必须与被匹配路由的 Community 一致，才判定为匹配成功。每个 Community 格式为 n:m，n、m 的取值范围为 1~65535。Community 需要符合 RFC 1997，不支持 Large Community（RFC 8092）。本参数与 CommunitySetInclude 互斥，不能同时指定。说明 Community 配置错误可能会导致路由不能发布到本地数据中心。	65000:100
DestinationInstanceIds	array	路由需匹配的目的实例 ID 列表。包含以下类型的实例 ID：专有网络 VPC（Virtual Private Cloud）实例 ID 边界路由器 VBR（Virtual Border Router）实例 ID 说明仅当路由策略的方向为出方向时，目的实例 ID 列表才会生效。
	string	路由需匹配的目的实例 ID 列表。包含以下类型的实例 ID：专有网络 VPC（Virtual Private Cloud）实例 ID 边界路由器 VBR（Virtual Border Router）实例 ID 说明仅当路由策略的方向为出方向时，目的实例 ID 列表才会生效。	vbr-gw8jiyiedko141709c903
DestinationInstanceIdsReverseMatch	boolean	是否使用目的实例 ID 列表的排除匹配模式。取值： false（默认值）：否，即路由传递的目的实例 ID 在DestinationInstanceIds.N中时，匹配通过。 true：是，即路由传递的目的实例 ID 不在DestinationInstanceIds.N中时，匹配通过。	false
DestinationInstanceTypes	array	路由需匹配的目的实例类型列表。支持以下实例类型： VPC：专有网络实例。 VBR：边界路由器实例。说明仅当路由策略的方向为出方向时，目的实例类型列表才会生效。
	string	路由需匹配的目的实例类型列表。支持以下实例类型： VPC：专有网络实例。 VBR：边界路由器实例。说明仅当路由策略的方向为出方向时，目的实例类型列表才会生效。	VPC
DestinationRegionIds	array	路由需匹配的目的地域 ID 列表。
	string	路由需匹配的目的地域 ID 列表。	all
DestinationRouteTableIds	array	路由需匹配的目的路由表 ID 列表。说明仅当路由策略的方向为出方向时，目的路由表 ID 列表才会生效。
	string	路由需匹配的目的路由表 ID 列表。说明仅当路由策略的方向为出方向时，目的路由表 ID 列表才会生效。	vtb-wz9x2kcw75vsceun3a0wg
MatchAddressType	string	路由需匹配的 IP 地址类型。取值： IPv4：表示只匹配 IPv4 路由。 IPv6：表示只匹配 IPv6 路由。本参数可以为空，表示匹配所有类型的路由。	IPv4
RouteTypes	array	路由需匹配的路由类型列表。支持以下路由类型： System：系统路由，由系统自动生成的路由。 Custom：自定义路由，由用户手动添加的路由。 BGP：BGP 路由，通过 BGP 路由协议传播的路由。支持输入多种路由类型。
	string	路由需匹配的路由类型列表。支持以下路由类型： System：系统路由，由系统自动生成的路由。 Custom：自定义路由，由用户手动添加的路由。 BGP：BGP 路由，通过 BGP 路由协议传播的路由。支持输入多种路由类型。	System
SourceInstanceIds	array	路由需匹配的源实例 ID 列表。包含以下类型的实例 ID：专有网络 VPC（Virtual Private Cloud）实例 ID 边界路由器 VBR（Virtual Border Router）实例 ID
	string	路由需匹配的源实例 ID 列表。包含以下类型的实例 ID：专有网络 VPC（Virtual Private Cloud）实例 ID 边界路由器 VBR（Virtual Border Router）实例 ID	vpc-2zea9zsh6ce30nfcjlvyr
SourceInstanceIdsReverseMatch	boolean	是否使用源实例 ID 列表的排除匹配模式。取值： false（默认值）：否，即路由传递的源实例 ID 在SourceInstanceIds.N中时，匹配通过。 true：是，即路由传递的源实例 ID 不在SourceInstanceIds.N中时，匹配通过。	false
SourceInstanceTypes	array	路由需匹配的源实例类型列表。支持以下实例类型： VPC：专有网络实例。 VBR：边界路由器实例。
	string	路由需匹配的源实例类型列表。支持以下实例类型： VPC：专有网络实例。 VBR：边界路由器实例。	VPC
SourceRegionIds	array	路由需匹配的源地域 ID 列表。
	string	路由需匹配的源地域 ID 列表。	cn-hongkong
SourceRouteTableIds	array	路由需匹配的源路由表 ID 列表。
	string	路由需匹配的源路由表 ID 列表。	vtb-uf684wwipxgflzkpe4zgd
Name	string	规则的名称。	Permit-Prod-Prefixes-Set-LP
Priority	integer	规则的优先级。优先级数字越小，代表优先级越高。	10
RouteMapId	string	路由策略的 ID。	rm-0a1b2c3d4e5f6a7b8
SetActions	object	路由策略规则的执行动作。路由命中 MatchConditions 中定义的全部匹配条件后，系统按照本参数中定义的动作处理路由。
AsPathPrepend	array	地域网关接收或发布路由时附加的 AS Path。本参数与 AsPathReplace 互斥，不能同时指定。本参数表示路由通过匹配条件后，要执行的操作。
	integer	地域网关接收或发布路由时附加的 AS Path。本参数与 AsPathReplace 互斥，不能同时指定。本参数表示路由通过匹配条件后，要执行的操作。	65000
AsPathReplace	array	地域网关接收或发布路由时替换的 AS Path。路由原有的 AS Path 将被替换为本参数指定的 AS 号列表。本参数与 AsPathPrepend 互斥，不能同时指定。本参数表示路由通过匹配条件后，要执行的操作。
	integer	地域网关接收或发布路由时替换的 AS Path。路由原有的 AS Path 将被替换为本参数指定的 AS 号列表。本参数与 AsPathPrepend 互斥，不能同时指定。本参数表示路由通过匹配条件后，要执行的操作。	65123
CommunityAdd	array	要为路由添加的 Community 集合。每个 Community 格式为 n:m，n、m 的取值范围为 1~65535。Community 需要符合 RFC 1997，不支持 Large Community（RFC 8092）。本参数与 CommunityReplace 互斥，不能同时指定。本参数表示路由通过匹配条件后，要执行的操作。说明 Community 配置错误可能会导致路由不能发布到本地数据中心。
	string	要为路由添加的 Community 集合。每个 Community 格式为 n:m，n、m 的取值范围为 1~65535。Community 需要符合 RFC 1997，不支持 Large Community（RFC 8092）。本参数与 CommunityReplace 互斥，不能同时指定。本参数表示路由通过匹配条件后，要执行的操作。说明 Community 配置错误可能会导致路由不能发布到本地数据中心。	65000:100
CommunityReplace	array	要替换路由原有 Community 的 Community 集合。每个 Community 格式为 n:m，n、m 的取值范围为 1~65535。Community 需要符合 RFC 1997，不支持 Large Community（RFC 8092）。本参数与 CommunityAdd 互斥，不能同时指定。本参数表示路由通过匹配条件后，要执行的操作。说明 Community 配置错误可能会导致路由不能发布到本地数据中心。
	string	要替换路由原有 Community 的 Community 集合。每个 Community 格式为 n:m，n、m 的取值范围为 1~65535。Community 需要符合 RFC 1997，不支持 Large Community（RFC 8092）。本参数与 CommunityAdd 互斥，不能同时指定。本参数表示路由通过匹配条件后，要执行的操作。说明 Community 配置错误可能会导致路由不能发布到本地数据中心。	65000:200
NextPriority	integer	关联的下一条路由策略规则的优先级。仅 RouteAction 取值为 Permit 时，才支持设置关联策略优先级，且被允许通过的路由才会继续匹配关联的下一条路由策略规则。关联的下一条路由策略规则的优先级必须低于当前路由策略规则的优先级。	1
RouteAction	string	所有条件都匹配后的策略行为。取值： Permit：允许匹配的路由通过。 Deny：拒绝匹配的路由通过。	Permit
RouteMapRuleId	string	路由策略规则的 ID。	rmr-3dm13f66wtctcnydup
Status	string	路由策略规则的状态。取值： Creating：创建中。 Updating：更新中。 Active：可用。 Deleting：删除中。 Deleted：已删除。	Active

示例

正常返回示例

JSON格式

{
  "TotalCount": 2,
  "RequestId": "EF44D7B7-6248-5A60-8A4C-A92388605A57",
  "NextToken": "dd20****",
  "MaxResults": 20,
  "RouteMapRules": [
    {
      "Description": "Matches production prefixes from on-prem and sets a higher local preference.",
      "MatchConditions": {
        "AddressPrefixesInclude": [
          "10.0.0.0/8"
        ],
        "AddressPrefixesMatch": [
          "10.0.0.0/8"
        ],
        "AsPathsInclude": [
          65000
        ],
        "AsPathsMatch": [
          65000
        ],
        "CommunitySetInclude": [
          "65000:100"
        ],
        "CommunitySetMatch": [
          "65000:100"
        ],
        "DestinationInstanceIds": [
          "vbr-gw8jiyiedko141709c903"
        ],
        "DestinationInstanceIdsReverseMatch": false,
        "DestinationInstanceTypes": [
          "VPC"
        ],
        "DestinationRegionIds": [
          "all"
        ],
        "DestinationRouteTableIds": [
          "vtb-wz9x2kcw75vsceun3a0wg"
        ],
        "MatchAddressType": "IPv4",
        "RouteTypes": [
          "System"
        ],
        "SourceInstanceIds": [
          "vpc-2zea9zsh6ce30nfcjlvyr"
        ],
        "SourceInstanceIdsReverseMatch": false,
        "SourceInstanceTypes": [
          "VPC"
        ],
        "SourceRegionIds": [
          "cn-hongkong"
        ],
        "SourceRouteTableIds": [
          "vtb-uf684wwipxgflzkpe4zgd"
        ]
      },
      "Name": "Permit-Prod-Prefixes-Set-LP",
      "Priority": 10,
      "RouteMapId": "rm-0a1b2c3d4e5f6a7b8",
      "SetActions": {
        "AsPathPrepend": [
          65000
        ],
        "AsPathReplace": [
          65123
        ],
        "CommunityAdd": [
          "65000:100"
        ],
        "CommunityReplace": [
          "65000:200"
        ],
        "NextPriority": 1,
        "RouteAction": "Permit"
      },
      "RouteMapRuleId": "rmr-3dm13f66wtctcnydup",
      "Status": "Active"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	IllegalParam.NextToken	NextToken is illegal	参数中指定的NextToken不合法。
400	InvalidParameter.MaxResults	The specified MaxResults is invalid.	参数中指定的MaxResults不合法。
400	InvalidParameter.RouteMapIds	The specified RouteMapIds is invalid.	输入的RouteMapIds参数不合法。
400	InvalidParameter.Filter	The specified Filter is invalid.	输入的Filter不合法。
400	InvalidParameter.RouteMapRuleIds	The specified parameter "RouteMapRuleIds" is invalid.	输入的RouteMapRuleIds参数不合法。
400	InvalidParameter.RouteMapId	The specified parameter RouteMapId is invalid.	输入的参数RouteMapId不合法。
400	MissingParameter.RouteMapIdOrRouteMapRuleIds	The input parameter "RouteMapId" or "RouteMapRuleIds" that is mandatory for processing this request is not supplied.	缺失请求参数RouteMapId或RouteMapRuleIds。

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

变更历史

更多信息，参考变更详情。