首页 云企业网 API参考 API目录 转发路由器路由条目 ListTransitRouterRouteEntries - 查询企业版转发路由器路由表中的路由条目信息

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

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

调试

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

调试

授权信息

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

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

请求参数

名称 类型 必填 描述 示例值
MaxResults integer

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

20
TransitRouterRouteEntryDestinationCidrBlock string

路由条目的目标网段。

192.168.0.0/24
TransitRouterRouteEntryStatus string

路由条目的状态。取值:

  • Creating:添加中。
  • Active:可用。
  • Deleting:删除中。
Active
TransitRouterRouteTableId string

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

vtb-bp1dudbh2d5na6b50****
NextToken string

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

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

路由条目的名称。

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

一次最多支持查询20条路由条目的信息。

说明 系统仅支持通过本参数查询静态配置的路由。
string

路由条目的名称。

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

一次最多支持查询20条路由条目的信息。

说明 系统仅支持通过本参数查询静态配置的路由。
testname
TransitRouterRouteEntryIds array

路由条目ID。

一次最多支持查询20条路由条目的信息。

说明 系统仅支持通过本参数查询静态配置的路由。
string

路由条目ID。

一次最多支持查询20条路由条目的信息。

说明 系统仅支持通过本参数查询静态配置的路由。
rte-oklkgwmj97z6dn****

返回参数

名称 类型 描述 示例值
object

返回结果。

NextToken string

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

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

请求ID。

C3835E5E-1504-4344-B1BB-98A4110F1079
TotalCount integer

总条目数。

6
MaxResults integer

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

20
TransitRouterRouteEntries array

路由条目信息列表。

object

路由条目信息。

TransitRouterRouteEntryId string

路由条目ID。

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

路由条目的目标网段。

192.168.0.0/24
TransitRouterRouteEntryType string

路由条目的类型。

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

路由条目的创建时间。

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

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

路由条目的名称。

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

路由条目的状态。

  • Creating:添加中。
  • Active:可用。
  • Deleting:删除中。
Active
TransitRouterRouteEntryNextHopType string

路由条目的下一跳类型。

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

路由条目的下一跳ID。

tr-attach-vx6iwhjr1x1j78****
TransitRouterRouteEntryDescription string

路由条目的描述信息。

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

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

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

路由条目的标签。

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

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

示例

正常返回示例

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": true,
      "Tag": "PermitVbr"
    }
  ]
}

错误码

Http code 错误码 错误信息 描述
400 IllegalParam.TransitRouterRouteTableId TransitRouterRouteTableId is illegal. 参数中指定的TransitRouterRouteTableId不合法。
400 IllegalParam.TransitRouterRouteEntryStatus TransitRouterRouteEntryStatus is illegal. 参数中指定的TransitRouterRouteEntryStatus不合法。
400 IllegalParam.NextToken NextToken is illegal. 参数中指定的NextToken不合法。
400 ParamExclusive.RouteEntryIdsAndStatus TransitRouterRouteEntryIds and TransitRouterRouteEntryStatus is mutually exclusive. TransitRouterRouteEntryIds和TransitRouterRouteEntryStatus参数互斥。
400 InvalidTransitRouterRouteTableId.NotFound TransitRouterRouteTableId is not found. 转发路由器路由表实例ID未找到。
404 InvalidRouteTableId.NotFound The specified RouteTableId is not found. RouteTableId不存在。

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

阿里云首页 云企业网 相关技术圈