文档

ListTransitRouterRouteTables - 查询企业版转发路由器的路由表信息

更新时间:

调用ListTransitRouterRouteTables接口查询企业版转发路由器的路由表的详细信息。

调试

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

授权信息

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

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

请求参数

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

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

20
NextTokenstring

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

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

路由表的类型。取值:

  • Custom:自定义路由表。
  • System:系统默认路由表。
Custom
TransitRouterIdstring

企业版转发路由器实例 ID。

tr-uf654ttymmljlvh2x****
TransitRouterRouteTableStatusstring

路由表的状态。取值:

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

路由表的名称。

您可以一次查询多个路由表的信息,N 的最大值为 20

说明 如果您同时通过TransitRouterRouteTableNames.NTransitRouterRouteTableIds.N查询路由表的信息时,路由表的名称和路由表的 ID 需保持一致。
string

路由表的名称。

您可以一次查询多个路由表的信息,N 的最大值为 20

说明 如果您同时通过TransitRouterRouteTableNames.NTransitRouterRouteTableIds.N查询路由表的信息时,路由表的名称和路由表的 ID 需保持一致。
testname
TransitRouterRouteTableIdsarray

路由表的 ID。

您可以一次查询多个路由表的信息,N 的最大值为 20

string

路由表的 ID。

您可以一次查询多个路由表的信息,N 的最大值为 20

vtb-bp1dudbh2d5na6b50****
Tagobject []

标签信息。

一次最多支持输入 20 个标签信息。

Keystring

资源的标签键。

一旦传入该值,则不允许为空字符串。最多支持 64 个字符,不能以aliyun或者acs:开头,不能包含http://或者https://

一次最多支持输入 20 个标签的标签键。

test
Valuestring

资源的标签值。

标签值可以为空或输入不超过 128 个字符的字符串,不能以aliyun或者acs:开头,不能包含http://或者https://

每一个标签键对应一个标签值,一次最多支持输入 20 个标签键对应的标签值。

test
RouteTableOptionsobject

路由表功能选项。

MultiRegionECMPstring

多地域等价路由,取值:

  • disable:关闭多地域等价路由。关闭多地域等价路由后,从不同地域学到的相同前缀的路由在其他路由属性一致的情况下将会优选 Region ID 最小的 TR 作为下一跳(按字母排序),此时流量的时延和不同地域间消耗的带宽会发生变化。请确保充分评估后再关闭。
  • enable:开启多地域等价路由。开启多地域等价路由后,从不同地域学到的相同前缀的路由在其他路由属性一致的情况下将会形成等价路由,此时流量的时延和不同地域间消耗的带宽会发生变化。请确保充分评估后再开启。
disable

返回参数

名称类型描述示例值
object

返回结果。

NextTokenstring

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

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

请求 ID。

82678F4A-C9F7-4CC1-8BF0-D619A63BFC57
TotalCountinteger

总条目数。

1
MaxResultsinteger

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

20
TransitRouterRouteTablesobject []

路由表信息列表。

TransitRouterRouteTableStatusstring

路由表的状态。

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

路由表的类型。

  • Custom:自定义路由表。
  • System:系统默认路由表。
System
CreateTimestring

路由表的创建时间。

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

2021-03-15T09:39Z
TransitRouterRouteTableIdstring

路由表 ID。

vtb-bp1dudbh2d5na6b50****
TransitRouterRouteTableNamestring

路由表的名称。

testname
TransitRouterRouteTableDescriptionstring

路由表的描述信息。

testdesc
Tagsobject []

标签列表。

Keystring

标签键。

test
Valuestring

标签值。

test
RouteTableOptionsobject

路由表功能选项。

MultiRegionECMPstring

多地域等价路由,取值:

  • disable:关闭多地域等价路由。关闭多地域等价路由后,从不同地域学到的相同前缀的路由在其他路由属性一致的情况下将会优选 Region ID 最小的 TR 作为下一跳(按字母排序),此时流量的时延和不同地域间消耗的带宽会发生变化。请确保充分评估后再关闭。
  • enable:开启多地域等价路由。开启多地域等价路由后,从不同地域学到的相同前缀的路由在其他路由属性一致的情况下将会形成等价路由,此时流量的时延和不同地域间消耗的带宽会发生变化。请确保充分评估后再开启。
disable
RegionIdstring

企业版转发路由器实例所属的地域 ID。

cn-beijing
TransitRouterIdstring

转发路由器实例 ID。

tr-8vb8bie2koduo5awz****

示例

正常返回示例

JSON格式

{
  "NextToken": "dd20****",
  "RequestId": "82678F4A-C9F7-4CC1-8BF0-D619A63BFC57",
  "TotalCount": 1,
  "MaxResults": 20,
  "TransitRouterRouteTables": [
    {
      "TransitRouterRouteTableStatus": "Active",
      "TransitRouterRouteTableType": "System",
      "CreateTime": "2021-03-15T09:39Z",
      "TransitRouterRouteTableId": "vtb-bp1dudbh2d5na6b50****",
      "TransitRouterRouteTableName": "testname",
      "TransitRouterRouteTableDescription": "testdesc",
      "Tags": [
        {
          "Key": "test",
          "Value": "test"
        }
      ],
      "RouteTableOptions": {
        "MultiRegionECMP": "disable"
      },
      "RegionId": "cn-beijing",
      "TransitRouterId": "tr-8vb8bie2koduo5awz****"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400IllegalParam.NextTokenNextToken is illegal参数中指定的NextToken不合法。
400InvalidTransitRouterId.NotFoundTransitRouterId is not found.转发路由实例ID不存在。
400IllegalParam.TagValueThe tag values are not valid.参数中指定的tag value不合法。
400IllegalParam.TagKeyThe tag keys are not valid.参数中指定的tag key不合法。
400MissingParam.TransitRouterIdOrTransitRouterRouteTablesEither TransitRouterId or TransitRouterRouteTables must be specified.参数错误,至少需要设置参数TransitRouterId和TransitRouterRouteTables中的一个。
400InvalidNameName is invalid.name不合法。
400InvalidParameterInvalid parameter.参数不合法。
400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。

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

变更历史

变更时间变更内容概要操作
2023-12-13OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2023-10-18OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
2023-03-09OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
出参OpenAPI 返回结构发生变更
2023-01-10OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:RouteTableOptions
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈