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

API描述

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

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

调试

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

请求参数

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

要执行的操作。取值:ListTransitRouters

CenId String cen-j3jzhw1zpau2km****

云企业网实例ID。

PageNumber Integer 1

查询页码。默认值为1

PageSize Integer 10

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

TransitRouterId String tr-uf654ttymmljlvh2x****

转发路由器实例ID。

RegionId String cn-shanghai

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

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

返回数据

名称 类型 示例值 描述
PageNumber Integer 1

查询页码。

PageSize Integer 10

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

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

请求ID。

TotalCount Integer 2

总条目数。

TransitRouters Array of TransitRouter

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

AliUid Long 1688111111111111

云企业网实例所属账号ID。

CenId String cen-j3jzhw1zpau2km****

云企业网实例ID。

CreationTime String 2021-03-15T09:39Z

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

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

RegionId String cn-qingdao

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

Status String Active

转发路由器实例状态。

  • Creating:创建中。
  • Active:可用。
  • Deleting:删除中。
  • Deleted:已经删除。
  • Upgrading:升级中。
TransitRouterDescription String testdesc

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

TransitRouterId String tr-bp1su1ytdxtataupl****

转发路由器实例ID。

TransitRouterName String testname

转发路由器实例的名称。

Type String Enterprise

转发路由器实例的类型。

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

示例

请求示例

http(s)://[Endpoint]/?Action=ListTransitRouters
&CenId=cen-j3jzhw1zpau2km****
&<公共请求参数>

正常返回示例

XML格式

<ListTransitRoutersResponse>
  <TotalCount>2</TotalCount>
  <RequestId>68521297-5FA6-46CB-B4EB-658F1C68C8CC</RequestId>
  <PageSize>10</PageSize>
  <PageNumber>1</PageNumber>
  <TransitRouters>
        <Status>Active</Status>
        <Type>Enterprise</Type>
        <CenId>cen-j3jzhw1zpau2km****</CenId>
        <CreationTime>2021-03-15T09:39Z</CreationTime>
        <TransitRouterName>zxtest</TransitRouterName>
        <RegionId>cn-hangzhou</RegionId>
        <TransitRouterId>tr-bp1su1ytdxtataupl****</TransitRouterId>
        <AliUid>1688111111111111</AliUid>
  </TransitRouters>
  <TransitRouters>
        <Status>Active</Status>
        <Type>Basic</Type>
        <CenId>cen-j3jzhw1zpau2km****</CenId>
        <CreationTime>2021-03-22T02:11Z</CreationTime>
        <RegionId>cn-qingdao</RegionId>
        <TransitRouterId>tr-m5eq27g6bndum7e88****</TransitRouterId>
        <AliUid>1688111111111111</AliUid>
  </TransitRouters>
</ListTransitRoutersResponse>

JSON格式

{
  "TotalCount": 2,
  "RequestId": "68521297-5FA6-46CB-B4EB-658F1C68C8CC",
  "PageSize": 10,
  "PageNumber": 1,
  "TransitRouters": [
    {
      "Status": "Active",
      "Type": "Enterprise",
      "CenId": "cen-j3jzhw1zpau2km****",
      "CreationTime": "2021-03-15T09:39Z",
      "TransitRouterName": "zxtest",
      "RegionId": "cn-hangzhou",
      "TransitRouterId": "tr-bp1su1ytdxtataupl****",
      "AliUid": "1688111111111111"
    },
    {
      "Status": "Active",
      "Type": "Basic",
      "CenId": "cen-j3jzhw1zpau2km****",
      "CreationTime": "2021-03-22T02:11Z",
      "RegionId": "cn-qingdao",
      "TransitRouterId": "tr-m5eq27g6bndum7e88****",
      "AliUid": "1688111111111111"
    }
  ]
}

错误码

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