文档

ListTransitRouters - 查询云企业网实例下转发路由器实例的信息

更新时间:

调用ListTransitRouters接口查询云企业网实例下转发路由器实例的实例类型、实例的状态、转发路由器实例ID、是否开启了组播功能等信息。

接口说明

在您调用本接口查询云企业网实例下转发路由器实例的信息时,您可以按需填写参数 RegionIdTransitRouterId,关于这两个参数的关系,请参见以下说明:

  • 如果您未输入 RegionIdTransitRouterId 的值,则表示您要查询云企业网实例下所有转发路由器实例的信息。
  • 如果您只输入了 RegionId 的值,则表示您要查询云企业网实例指定地域下的转发路由器实例的信息。
  • 如果您只输入了 TransitRouterId 的值,则表示您要查询云企业网实例中指定的转发路由器实例的信息。
  • 如果您同时输入了 RegionIdTransitRouterId 的值,则表示您要查询云企业网实例指定地域下指定的转发路由器实例的信息。

调试

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

调试

授权信息

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

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

请求参数

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

列表的页码。默认值:1

1
PageSizeinteger

分页查询时每页显示的条目数。取值范围:1~50。默认值:10

10
CenIdstring

云企业网实例 ID。

cen-j3jzhw1zpau2km****
TransitRouterIdstring

转发路由器实例 ID。

tr-uf654ttymmljlvh2x****
RegionIdstring

转发路由器实例所属地域 ID。

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

ap-southeast-2
Tagobject []

标签信息。

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

Keystring

资源的标签键。

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

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

TagKey
Valuestring

资源的标签值。

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

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

TagValue
Statusstring

转发路由器实例的状态。

  • Creating:创建中。
  • Active:可用。
  • Modifying:修改中。
  • Deleting:删除中。
  • Upgrading:升级中。
Active
Typestring

转发路由器实例的类型。

  • Enterprise:企业版。
  • Basic:基础版。
Enterprise
TransitRouterNamestring

企业版转发路由器实例的名称。

名称长度为 2~128 个字符,必须以字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-),但不能以http://https://开头。

testname
FeatureFilterobject []

转发路由器功能筛选字段。

Keystring

转发路由器功能筛选字段键值。 目前支持字段:

  • Multicast:组播功能。
Multicast
Valuearray

转发路由器功能筛选字段值列表。 当键值为 Multicast 时,只支持填入 1 个字段,支持字段内容为:

  • Enabled:支持组播。
  • Disabled:不支持组播。
string

转发路由器功能筛选字段值。 当键值为 Multicast 时支持字段为:

  • Enabled:支持组播。
  • Disabled:不支持组播。
Enabled

返回参数

名称类型描述示例值
object

返回结果。

PageSizeinteger

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

10
RequestIdstring

请求 ID。

68521297-5FA6-46CB-B4EB-658F1C68C8CC
PageNumberinteger

列表的页码。

1
TotalCountinteger

列表条目数。

1
TransitRoutersobject []

转发路由器实例信息列表。

CreationTimestring

转发路由器实例的创建时间。

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

2021-03-15T09:39Z
Typestring

转发路由器实例的类型。

  • Enterprise:企业版。
  • Basic:基础版。
Enterprise
Statusstring

转发路由器实例的状态。

  • Creating:创建中。
  • Active:可用。
  • Modifying:修改中。
  • Deleting:删除中。
  • Upgrading:升级中。
Active
TransitRouterIdstring

转发路由器实例 ID。

tr-bp1su1ytdxtataupl****
TransitRouterDescriptionstring

转发路由器实例的描述信息。

testdesc
TransitRouterNamestring

转发路由器实例的名称。

testname
CenIdstring

云企业网实例 ID。

cen-j3jzhw1zpau2km****
AliUidlong

云企业网实例所属阿里云账号(主账号)ID。

1210123456123456
RegionIdstring

转发路由器实例所属地域 ID。

ap-southeast-2
SupportMulticastboolean

转发路由器实例是否开启了组播功能。

  • true:已开启。
  • false:未开启。
false
TransitRouterCidrListobject []

转发路由器地址段列表。

Cidrstring

转发路由器地址段。

192.168.1.0/24
Namestring

转发路由器地址段的名称。

CIDRname
Descriptionstring

转发路由器地址段的描述信息。

CIDRdesc
TransitRouterCidrIdstring

转发路由器地址段 ID。

cidr-46p5ceg21e8152****
PublishCidrRouteboolean

是否允许系统自动在转发路由器路由表中添加转发路由器地址段的路由。

  • true:允许。

      如果当前参数返回值为 **true**,则在您创建了私网网关类型的 VPN 连接,并为私网网关类型的 VPN 连接创建了路由学习关系后,系统自动在与 VPN 连接建立路由学习关系的转发路由器路由表中添加一条路由条目:
      目标网段为转发路由器地址段的黑洞路由,其中转发路由器地址段指已为 IPsec 连接分配网关 IP 地址的地址段。
      该黑洞路由仅会被传播至转发路由器下 VBR 实例的路由表中。
    
  • false:不允许。

true
Tagsobject []

标签列表。

Keystring

标签键。

TagKey
Valuestring

标签值。

TagValue

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "68521297-5FA6-46CB-B4EB-658F1C68C8CC",
  "PageNumber": 1,
  "TotalCount": 1,
  "TransitRouters": [
    {
      "CreationTime": "2021-03-15T09:39Z",
      "Type": "Enterprise",
      "Status": "Active",
      "TransitRouterId": "tr-bp1su1ytdxtataupl****",
      "TransitRouterDescription": "testdesc",
      "TransitRouterName": "testname",
      "CenId": "cen-j3jzhw1zpau2km****",
      "AliUid": 1210123456123456,
      "RegionId": "ap-southeast-2",
      "SupportMulticast": false,
      "TransitRouterCidrList": [
        {
          "Cidr": "192.168.1.0/24",
          "Name": "CIDRname",
          "Description": "CIDRdesc",
          "TransitRouterCidrId": "cidr-46p5ceg21e8152****",
          "PublishCidrRoute": true
        }
      ],
      "Tags": [
        {
          "Key": "TagKey",
          "Value": "TagValue"
        }
      ]
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterCombination.TransitRouterRegion ID is required if no TransitRouterId or CenId specified.至少需要传入Region,TransitRouterId 或CenId三者中的一个。
400InvalidOperation.UnsupportFilterValueThe specified FeatureFilter Value is not supported by this operation.参数中指定的FeatureFilter Value不合法。
400InvalidOperation.UnsupportFilterThe specified FeatureFilter is not supported by this operation.参数中指定的FeatureFilter不合法。
400IllegalParam.TagValueThe tag values are not valid.参数中指定的tag value不合法。
400IllegalParam.TagKeyThe tag keys are not valid.参数中指定的tag key不合法。
400InvalidParameterInvalid parameter.参数不合法。
400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。

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

变更历史

变更时间变更内容概要操作
2023-10-18OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
2023-01-09OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:Status
    新增入参:Type
    新增入参:TransitRouterName
    新增入参:FeatureFilter
  • 本页导读 (1)
文档反馈