Queries the transit routers connected to a CEN instance.

Usage notes

You can set the RegionId and TransitRouterId parameters based on your requirements.

  • If you do not set RegionId or TransitRouterId, the system queries all transit routers connected to the specified CEN instance.
  • If you set only RegionId, the system queries transit routers that are deployed in the specified region.
  • If you set only TransitRouterId, the system queries the specified transit router.
  • If you set both RegionId and TransitRouterId, the system queries the specified transit router in the specified region.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListTransitRouters

The operation that you want to perform. Set the value to ListTransitRouters.

PageNumber Integer No 1

The page number of the page to return. Default value: 1.

PageSize Integer No 10

The number of entries to return on each page. Valid values: 1 to 50. Default value: 10.

CenId String Yes cen-j3jzhw1zpau2km****

The ID of the CEN instance.

TransitRouterId String No tr-uf654ttymmljlvh2x****

The ID of the transit router.

RegionId String No cn-qingdao

The ID of the region where the transit router is deployed.

You can call the DescribeRegions operation to query the most recent region list.

Response parameters

Parameter Type Example Description
PageSize Integer 10

The number of entries returned per page.

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

The ID of the request.

PageNumber Integer 1

The number of the returned page.

TotalCount Integer 2

The number of entries returned.

TransitRouters Array of TransitRouter

A list of transit routers.

CreationTime String 2021-03-15T09:39Z

The time when the transit router was created.

The time follows the ISO8601 standard in the YYYY-MM-DDThh:mmZ format. The time is displayed in UTC.

Type String Enterprise

The edition of the transit router. Valid values:

  • Enterprise: Enhance Edition
  • Basic: Basic Edition
Status String Active

The status of the transit router. Valid values:

  • Creating: The transit router is being created.
  • Active: The transit router is available.
  • Modifying: The transit router is being modified
  • Deleting: The transit router is being deleted.
  • Upgrading: The transit router is being upgraded.
TransitRouterId String tr-bp1su1ytdxtataupl****

The ID of the transit router.

TransitRouterDescription String testdesc

The description of the transit router.

TransitRouterName String testname

The name of the transit router.

CenId String cen-j3jzhw1zpau2km****

The ID of the CEN instance.

AliUid Long 253460731706911258

The ID of the Alibaba Cloud account to which the CEN instance belongs.

RegionId String cn-qingdao

The ID of the region where the transit router is deployed.

SupportMulticast Boolean false

Indicates whether multicast is enabled for the transit router. Valid values:

  • true: enabled
  • false: disabled

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListTransitRouters
&PageNumber=1
&PageSize=10
&CenId=cen-j3jzhw1zpau2km****
&TransitRouterId=tr-uf654ttymmljlvh2x****
&RegionId=cn-qingdao
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/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>253460731706911258</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>253460731706911258</AliUid>
    </TransitRouters>
</ListTransitRoutersResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/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" : "253460731706911258"
  }, {
    "Status" : "Active",
    "Type" : "Basic",
    "CenId" : "cen-j3jzhw1zpau2km****",
    "CreationTime" : "2021-03-22T02:11Z",
    "RegionId" : "cn-qingdao",
    "TransitRouterId" : "tr-m5eq27g6bndum7e88****",
    "AliUid" : "253460731706911258"
  } ]
}

Error codes

For a list of error codes, visit the API Error Center.