Queries the route tables of an Enterprise Edition transit router.

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 ListTransitRouterRouteTables

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

MaxResults Integer No 20

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

NextToken String No dd20****

The token that determines the start point of the query. Valid values:

  • If this is your first query or no subsequent query is to be sent, ignore this parameter.
  • If a next query is to be sent, set the value to the value of NextToken that is returned from the last call.
TransitRouterRouteTableType String No Custom

The type of the route table. Valid values:

  • Custom: a custom route table
  • System: the default route table
TransitRouterId String Yes tr-uf654ttymmljlvh2x****

The ID of the Enterprise Edition transit router.

TransitRouterRouteTableStatus String No Active

The status of the route table. Valid values:

  • Creating: being created
  • Deleting: being deleted
  • Active: available
TransitRouterRouteTableNames.N String No testname

The name of the route table.

You can query multiple route tables in each call. Maximum value of N: 20.

Note If you specify set both TransitRouterRouteTableNames.N and TransitRouterRouteTableIds.N, make sure that the specified name and ID belong to the same route table.
TransitRouterRouteTableIds.N String No vtb-bp1dudbh2d5na6b50****

The ID of the route table.

You can query multiple route tables in each call. Maximum value of N: 20.

Response parameters

Parameter Type Example Description
NextToken String dd20****

The token that determines the start point of the query. Valid values:

  • If NextToken was not returned in the previous query, it indicates that no additional results exist.
  • If NextToken was returned in the previous query, specify the value to obtain the next set of results.
RequestId String 82678F4A-C9F7-4CC1-8BF0-D619A63BFC57

The ID of the request.

TotalCount Integer 1

The total number of entries returned.

MaxResults Integer 20

The number of entries returned per page.

TransitRouterRouteTables Array of TransitRouterRouteTable

A list of route tables.

TransitRouterRouteTableStatus String Active

The status of the route table.

  • Creating: being created
  • Deleting: being deleted
  • Active: available
TransitRouterRouteTableType String System

The type of the route table.

  • Custom: a custom route table
  • System: the default route table
CreateTime String 2021-03-15T09:39Z

The time when the route table was created.

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

TransitRouterRouteTableId String vtb-bp1dudbh2d5na6b50****

The ID of the route table.

TransitRouterRouteTableName String testname

The name of the route table.

TransitRouterRouteTableDescription String testdesc

The description of the route table.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListTransitRouterRouteTables
&MaxResults=1
&NextToken=dd20****
&TransitRouterRouteTableType=Custom
&TransitRouterId=tr-uf654ttymmljlvh2x****
&TransitRouterRouteTableStatus=Active
&TransitRouterRouteTableNames=["testname"]
&TransitRouterRouteTableIds=["vtb-bp1dudbh2d5na6b50****"]
&<Common request parameters>

Sample success responses

XML format 

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

<ListTransitRouterRouteTablesResponse>
    <NextToken>dd20****</NextToken>
    <RequestId>82678F4A-C9F7-4CC1-8BF0-D619A63BFC57</RequestId>
    <TotalCount>1</TotalCount>
    <MaxResults>1</MaxResults>
    <TransitRouterRouteTables>
        <TransitRouterRouteTableStatus>Active</TransitRouterRouteTableStatus>
        <TransitRouterRouteTableType>System</TransitRouterRouteTableType>
        <CreateTime>2021-03-15T09:39Z</CreateTime>
        <TransitRouterRouteTableId>vtb-bp1dudbh2d5na6b50****</TransitRouterRouteTableId>
        <TransitRouterRouteTableName>testname</TransitRouterRouteTableName>
        <TransitRouterRouteTableDescription>testdesc</TransitRouterRouteTableDescription>
    </TransitRouterRouteTables>
</ListTransitRouterRouteTablesResponse>

JSON format 

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

{
  "NextToken" : "dd20****",
  "RequestId" : "82678F4A-C9F7-4CC1-8BF0-D619A63BFC57",
  "TotalCount" : 1,
  "MaxResults" : 1,
  "TransitRouterRouteTables" : [ {
    "TransitRouterRouteTableStatus" : "Active",
    "TransitRouterRouteTableType" : "System",
    "CreateTime" : "2021-03-15T09:39Z",
    "TransitRouterRouteTableId" : "vtb-bp1dudbh2d5na6b50****",
    "TransitRouterRouteTableName" : "testname",
    "TransitRouterRouteTableDescription" : "testdesc"
  } ]
}

Error codes

HttpCode Error code Error message Description
400 InvalidTransitRouterId.NotFound TransitRouterId is not found. The error message returned because the ID of the transit router is invalid.

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