全部产品
Search
文档中心

云企业网:ListTransitRouterRouteEntries - 查询企业版转发路由器路由表中的路由条目信息

更新时间:Nov 28, 2023

查询企业版转发路由器路由表中的路由条目信息。

调试

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

调试

授权信息

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

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

请求参数

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

分批次查询时,每次显示的条目数。取值范围:1~100。默认值:20

20
TransitRouterRouteEntryDestinationCidrBlockdeprecatedstring

路由条目的目标网段(本参数即将废弃,建议使用RouteFilter参数)。

192.168.0.0/24
TransitRouterRouteEntryStatusstring

路由条目的状态。取值:

  • All:表示查询全部状态的路由条目。
  • Active(默认值):表示仅查询生效状态的路由条目。
  • Rejected:表示仅查询因路由冲突而被拒绝的路由条目。
  • Prohibited:表示仅查询因匹配到路由策略而被禁止的路由条目。
  • Standby:表示仅查询作为备份的路由条目。
  • Candidate:表示仅查询作为候选的路由条目。

如果您未指定本参数的值,系统默认仅查询生效状态的路由条目。

Active
TransitRouterRouteTableIdstring

企业版转发路由器路由表ID。

vtb-bp1dudbh2d5na6b50****
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次API调用返回的NextToken值。
fce19****
TransitRouterRouteEntryNamesarray

路由条目的名称。

名称长度为0~128个字符,可包含英文字母、数字、中文、半角逗号(,)、半角句号(.)、半角分号(;)、正斜线(/)、at(@)、下划线(_)和短划线(-)。

说明 系统仅支持通过本参数查询当前路由表上静态配置的路由,且与TransitRouterRouteEntryIds之外的其他查询条件不兼容。
string

路由条目的名称。

名称长度为0~128个字符,可包含英文字母、数字、中文、半角逗号(,)、半角句号(.)、半角分号(;)、正斜线(/)、at(@)、下划线(_)和短划线(-)。

说明 系统仅支持通过本参数查询当前路由表上静态配置的路由,且与TransitRouterRouteEntryIds之外的其他查询条件不兼容。
testname
TransitRouterRouteEntryIdsarray

路由条目ID。

说明 系统仅支持通过本参数查询当前路由表上静态配置的路由,且与TransitRouterRouteEntryNames之外的其他查询条件不兼容。
string

路由条目ID。

说明 系统仅支持通过本参数查询当前路由表上静态配置的路由,且与TransitRouterRouteEntryNames之外的其他查询条件不兼容。
rte-oklkgwmj97z6dn****
TransitRouterRouteEntryTypestring

路由条目的类型。取值:

  • Propagated:当前路由表自动学习产生。
  • Static:当前路由表静态配置产生。
Propagated
TransitRouterRouteEntryNextHopTypestring

下一跳类型。取值:

  • BlackHole:表示指定该路由条目为黑洞路由。
  • Attachment:表示指定该路由条目的下一跳为网络实例连接。
Attachment
TransitRouterRouteEntryNextHopIdstring

路由条目的下一跳所关联的网络实例连接ID。

tr-attach-nls9fzkfat8934****
TransitRouterRouteEntryNextHopResourceIdstring

路由条目的下一跳实例ID。

vpc-m5ent6du8deaq5*****
TransitRouterRouteEntryNextHopResourceTypestring

路由条目的下一跳实例类型。取值:

  • VPC:专有网络VPC(Virtual Private Cloud)实例。
  • VBR:边界路由器VBR(Virtual Border Router)实例。
  • TR:转发路由器实例。
  • VPN:IPsec连接实例。
VPC
TransitRouterRouteEntryOriginResourceIdstring

路由条目的起源实例ID。

vpc-m5ent6du8deaq5*****
TransitRouterRouteEntryOriginResourceTypestring

路由条目的起源实例类型。取值:

  • VPC:专有网络VPC(Virtual Private Cloud)实例。
  • VBR:边界路由器VBR(Virtual Border Router)实例。
  • TR:转发路由器实例。
  • VPN:IPsec连接实例。
VPC
PrefixListIdstring

前缀列表ID。

pl-6ehtn5kqxgeyy08fi****
RouteFilterobject []

路由条目网段过滤的条件信息。

Keystring

过滤条件。取值:

  • PrefixExactMatchCidrs:精确匹配。
  • LongestPrefixMatchCidrs:最长前缀匹配,支持传入IP和CIDR。
  • SubnetOfMatchCidrs:子网匹配,匹配传入的CIDR的子网,含传入的CIDR。
  • SupernetOfMatchCidrs:超网匹配,匹配传入的CIDR的超网,含传入的CIDR。

多个过滤条件之间默认是的关系,即必须符合所有过滤条件,才视为匹配过滤条件。不能重复传入相同的过滤条件。

PrefixExactMatchCidrs
Valuearray

过滤条件值的列表。

string

根据Key指定过滤值。一个Key支持指定多个过滤值,多个过滤值之间是或的关系,即只要符合其中一个过滤值,则视为匹配该过滤条件。 一个过滤条件最多支持输入500个过滤值。

192.168.1.0/24

返回参数

名称类型描述示例值
object

返回结果。

NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 如果NextToken为空表示没有下一次查询。
  • 如果NextToken有返回值,该取值表示下一次查询开始的令牌。
fce19****
RequestIdstring

请求ID。

C3835E5E-1504-4344-B1BB-98A4110F1079
TotalCountinteger

总条目数。

6
MaxResultsinteger

分批次查询时,每次显示的条目数。

20
TransitRouterRouteEntriesobject []

路由条目信息列表。

TransitRouterRouteEntryIdstring

路由条目ID。

说明 只有静态配置的路由才会返回该参数值。
rte-oklkgwmj97z6dn****
TransitRouterRouteEntryDestinationCidrBlockstring

路由条目的目标网段。

192.168.0.0/24
TransitRouterRouteEntryTypestring

路由条目的类型。

  • Static:表示该路由条目为静态配置的路由。
  • Propagated:表示该路由条目为自动学习到的路由。
Static
CreateTimestring

路由条目的创建时间。

时间按照ISO8601标准表示,并使用UTC时间。格式为:YYYY-MM-DDThh:mmZ。

说明 只有静态配置的路由才会返回该参数值。
2021-06-15T07:01Z
TransitRouterRouteEntryNamestring

路由条目的名称。

说明 只有静态配置的路由才会返回该参数值。
testname
TransitRouterRouteEntryStatusstring

路由条目的生效状态。

  • Active:生效。
  • Rejected:路由冲突拒绝。
  • Prohibited:路由策略禁止。
  • Standby:备份。
  • Candidate:候选。
  • Creating:添加中。
  • Deleting:删除中。
Active
TransitRouterRouteEntryNextHopTypestring

路由条目的下一跳类型。

  • BlackHole:表示该路由条目为黑洞路由,所有去往目标网段的路由均会被丢弃。
  • Attachment:表示该路由条目的下一跳为网络实例连接,所有去往目标网段的路由均会被转发至指定的网络实例连接。
BlackHole
TransitRouterRouteEntryNextHopIdstring

路由条目的下一跳ID。黑洞路由不会返回该参数值。

tr-attach-vx6iwhjr1x1j78****
TransitRouterRouteEntryDescriptionstring

路由条目的描述信息。

说明 只有静态配置的路由才会返回该参数值。
CidrRoute
OperationalModeboolean

当前路由条目是否可操作。

  • true:可操作,表示您可以对当前路由条目执行删除操作。
  • false:不可操作,表示当前路由条目为系统自动生成,不支持编辑。
false
Tagstring

路由条目的标签。

仅取值:PermitVbr,表示当前路由条目仅会被传播至转发路由器实例下VBR实例的路由表中。

说明 仅系统自动生成的转发路由器地址段的路由会返回当前参数。
PermitVbr
TransitRouterRouteEntryNextHopResourceIdstring

路由条目的下一跳实例ID。

vpc-m5ent6du8deaq5*****
TransitRouterRouteEntryNextHopResourceTypestring

路由条目的下一跳实例类型。

  • VPC:专有网络VPC(Virtual Private Cloud)实例。
  • VBR:边界路由器VBR(Virtual Border Router)实例。
  • TR:转发路由器实例。
  • VPN:IPsec连接实例。
VPC
TransitRouterRouteEntryOriginResourceTypestring

路由条目的起源实例类型。

  • VPC:专有网络VPC(Virtual Private Cloud)实例。
  • VBR:边界路由器VBR(Virtual Border Router)实例。
  • TR:转发路由器实例。
  • VPN:IPsec连接实例。
VPC
TransitRouterRouteEntryOriginResourceIdstring

路由条目的起源实例ID。

vpc-m5ent6du8deaq5*****
PrefixListIdstring

前缀列表ID。

pl-k1ainl66z3527773d****
PathAttributesobject

路由路径属性。

Communitiesarray

路由条目的Community属性列表。

string

路由条目的Community属性值。

65501:1
AsPathsarray

路由条目的AS Path属性列表。

string

路由条目的AS Path属性值。

65501
OriginInstanceIdstring

路由产生的原始实例ID。

vbr-m5ent6du8deaq5*****
OriginInstanceTypestring

路由产生的原始实例类型。

  • VPC:专有网络VPC(Virtual Private Cloud)实例。
  • VBR:边界路由器VBR(Virtual Border Router)实例。
  • TR:转发路由器实例。
  • VPN:IPsec连接实例。
  • CCN:云连接网(Cloud Connect Network)实例。
VBR
OriginRouteTypestring

路由产生时候的路由类型。

  • System:系统路由。
  • Custom:自定义路由。
  • Static:静态路由。
  • BGP:BGP路由。
  • BlackHole:黑洞路由。
BGP
Preferenceinteger

路由条目的优先级。

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

50

示例

正常返回示例

JSON格式

{
  "NextToken": "fce19****",
  "RequestId": "C3835E5E-1504-4344-B1BB-98A4110F1079",
  "TotalCount": 6,
  "MaxResults": 20,
  "TransitRouterRouteEntries": [
    {
      "TransitRouterRouteEntryId": "rte-oklkgwmj97z6dn****",
      "TransitRouterRouteEntryDestinationCidrBlock": "192.168.0.0/24",
      "TransitRouterRouteEntryType": "Static",
      "CreateTime": "2021-06-15T07:01Z",
      "TransitRouterRouteEntryName": "testname",
      "TransitRouterRouteEntryStatus": "Active",
      "TransitRouterRouteEntryNextHopType": "BlackHole",
      "TransitRouterRouteEntryNextHopId": "tr-attach-vx6iwhjr1x1j78****",
      "TransitRouterRouteEntryDescription": "CidrRoute",
      "OperationalMode": false,
      "Tag": "PermitVbr",
      "TransitRouterRouteEntryNextHopResourceId": "vpc-m5ent6du8deaq5*****",
      "TransitRouterRouteEntryNextHopResourceType": "VPC",
      "TransitRouterRouteEntryOriginResourceType": "VPC",
      "TransitRouterRouteEntryOriginResourceId": "vpc-m5ent6du8deaq5*****",
      "PrefixListId": "pl-k1ainl66z3527773d****",
      "PathAttributes": {
        "Communities": [
          "65501:1"
        ],
        "AsPaths": [
          "65501"
        ],
        "OriginInstanceId": "vbr-m5ent6du8deaq5*****\n",
        "OriginInstanceType": "VBR",
        "OriginRouteType": "BGP",
        "Preference": 50
      }
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400IllegalParam.TransitRouterRouteTableIdTransitRouterRouteTableId is illegal.参数中指定的TransitRouterRouteTableId不合法。
400IllegalParam.TransitRouterRouteEntryStatusTransitRouterRouteEntryStatus is illegal.参数中指定的TransitRouterRouteEntryStatus不合法。
400IllegalParam.NextTokenNextToken is illegal.参数中指定的NextToken不合法。
400ParamExclusive.RouteEntryIdsAndStatusTransitRouterRouteEntryIds and TransitRouterRouteEntryStatus is mutually exclusive.TransitRouterRouteEntryIds和TransitRouterRouteEntryStatus参数互斥。
400InvalidTransitRouterRouteTableId.NotFoundTransitRouterRouteTableId is not found.转发路由器路由表实例ID未找到。
400FilterKeyDuplicated.RouteFilterThe keys in RouteFilter are duplicated.RouteFilter中的key值重复
400InvalidFilterKeyThe key in filter is invalid.The key in filter is invalid.
400IllegalParam.TransitRouterRouteEntryNextHopTypeTransitRouterRouteEntryNextHopType is invalid.TransitRouterRouteEntryNextHopType参数不合法
400IllegalParam.TransitRouterRouteEntryNextHopAttachmentIdTransitRouterRouteEntryNextHopAttachmentId is invalid.TransitRouterRouteEntryNextHopAttachmentId参数不合法
400IllegalParam.TransitRouterRouteEntryNextHopResourceIdTransitRouterRouteEntryNextHopResourceId is invalid.TransitRouterRouteEntryNextHopResourceId参数不合法
400IllegalParam.TransitRouterRouteEntryNextHopResourceTypeTransitRouterRouteEntryNextHopResourceType is invalid.TransitRouterRouteEntryNextHopResourceType参数不合法
400IllegalParam.TransitRouterRouteEntryOriginResourceIdTransitRouterRouteEntryOriginResourceId is invalid.TransitRouterRouteEntryOriginResourceId参数不合法
400IllegalParam.TransitRouterRouteEntryOriginResourceTypeTransitRouterRouteEntryOriginResourceType is invalid.TransitRouterRouteEntryOriginResourceType参数非法
400IllegalParam.TransitRouterRouteEntryTypeTransitRouterRouteEntryType is invalid.TransitRouterRouteEntryType参数不合法
400IllegalParam.PrefixExactMatchCidrPrefixExactMatchCidr is invalid.PrefixExactMatchCidr参数不合法
400IllegalParam.LongestPrefixMatchCidrLongestPrefixMatchCidr is invalid.LongestPrefixMatchCidr参数不合法
400IllegalParam.SubnetOfMatchCidrSubnetOfMatchCidr is invalid.SubnetOfMatchCidr参数不合法
400IllegalParam.SupernetOfMatchCidrSupernetOfMatchCidr is invalid.SupernetOfMatchCidr参数不合法
400InvalidParameterInvalid parameter.参数不合法。
400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。
404InvalidRouteTableId.NotFoundThe specified RouteTableId is not found.RouteTableId不存在。

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

变更历史

变更时间变更内容概要操作
2023-07-13OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
出参OpenAPI 返回结构发生变更
2023-07-07OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
出参OpenAPI 返回结构发生变更
2023-07-07OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
出参OpenAPI 返回结构发生变更
2023-04-04OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:404
2023-03-02OpenAPI 错误码发生变更,OpenAPI 入参发生变更,OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:TransitRouterRouteEntryType
    新增入参:TransitRouterRouteEntryNextHopType
    新增入参:TransitRouterRouteEntryNextHopId
    新增入参:TransitRouterRouteEntryNextHopResourceId
    新增入参:TransitRouterRouteEntryNextHopResourceType
    新增入参:TransitRouterRouteEntryOriginResourceId
    新增入参:TransitRouterRouteEntryOriginResourceType
    新增入参:PrefixListId
    新增入参:RouteFilter
出参OpenAPI 返回结构发生变更