调用ListTransitRouters接口查询云企业网实例下转发路由器实例的信息。

使用说明

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

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListTransitRouters

系统规定参数。取值:ListTransitRouters

PageNumber Integer 1

列表的页码。默认值:1

PageSize Integer 10

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

CenId String cen-j3jzhw1zpau2km****

云企业网实例ID。

TransitRouterId String tr-uf654ttymmljlvh2x****

转发路由器实例ID。

RegionId String ap-southeast-2

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

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

Tag.N.Key String TagKey

资源的标签键。

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

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

Tag.N.Value String TagValue

资源的标签值。

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

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

返回数据

名称 类型 示例值 描述
PageSize Integer 10

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

RequestId String 68521297-5FA6-46CB-B4EB-658F1C68C8CC

请求ID。

PageNumber Integer 1

列表的页码。

TotalCount Integer 1

列表条目数。

TransitRouters Array of TransitRouter

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

CreationTime String 2021-03-15T09:39Z

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

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

Type String Enterprise

转发路由器实例的类型。

  • Enterprise:企业版。
  • Basic:基础版。
Status String Active

转发路由器实例的状态。

  • Creating:创建中。
  • Active:可用。
  • Modifying:修改中。
  • Deleting:删除中。
  • Upgrading:升级中。
TransitRouterId String tr-bp1su1ytdxtataupl****

转发路由器实例ID。

TransitRouterDescription String testdesc

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

TransitRouterName String testname

转发路由器实例的名称。

CenId String cen-j3jzhw1zpau2km****

云企业网实例ID。

AliUid Long 1210123456123456

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

RegionId String ap-southeast-2

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

SupportMulticast Boolean false

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

  • true:已开启。
  • false:未开启。
TransitRouterCidrList Array of TransitRouterCidrList

转发路由器地址段列表。

Cidr String 192.168.1.0/24

转发路由器地址段。

Name String CIDRname

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

Description String CIDRdesc

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

TransitRouterCidrId String cidr-46p5ceg21e8152****

转发路由器地址段ID。

PublishCidrRoute Boolean true

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

  • true:允许。

    如果当前参数返回值为true,则在您创建了私网网关类型的VPN连接,并为私网网关类型的VPN连接创建了路由学习关系后,系统自动在与VPN连接建立路由学习关系的转发路由器路由表中添加一条路由条目:

    目标网段为转发路由器地址段的黑洞路由,其中转发路由器地址段指已为IPsec连接分配网关IP地址的地址段。

    该黑洞路由仅会被传播至转发路由器下VBR实例的路由表中。

  • false:不允许。
Tags Array of Tag

标签列表。

Key String TagKey

标签键。

Value String TagValue

标签值。

示例

请求示例

http(s)://[Endpoint]/?Action=ListTransitRouters
&PageNumber=1
&PageSize=10
&CenId=cen-j3jzhw1zpau2km****
&TransitRouterId=tr-uf654ttymmljlvh2x****
&RegionId=ap-southeast-2
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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
    } ]
  } ]
}

错误码

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