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 No ListTransitRouterRouteTables

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

TransitRouterId String Yes tr-uf654ttymmljlvh2x****

The ID of the Enterprise Edition transit router.

MaxResults Integer No 1

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

TransitRouterRouteTableNames.N RepeatList 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 both TransitRouterRouteTableNames.N and TransitRouterRouteTableIds.N, make sure that the specified name and ID belong to the same route table.
TransitRouterRouteTableIds.N RepeatList No vtb-bp1l8awdb4iuo9uwu****

The ID of the route table.

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

NextToken String No dd20****

The token for returning the next page when the data is returned in more than one page.

TransitRouterRouteTableType String No Custom

The type of route table. Valid values:

  • Custom: a custom route table
  • System: the default route table
TransitRouterRouteTableStatus String No Active

The state of the route table. Valid values:

  • Creating: The route table is being created.
  • Deleting: The route table is being deleted.
  • Active: The route table is available for use.

Response parameters

Parameter Type Example Description
MaxResults Integer 1

The number of entries returned per page.

NextToken String dd20****

The token for returning the next page when the data is returned in more than one page.

RequestId String 82678F4A-C9F7-4CC1-8BF0-D619A63BFC57

The ID of the request.

TotalCount Integer 1

The total number of entries returned.

TransitRouterRouteTables Array of TransitRouterRouteTable

The list of route tables.

CreateTime String 2021-03-15T09:39Z

The time when the route table was created.

The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.

TransitRouterRouteTableDescription String testb

The description of the route table.

TransitRouterRouteTableId String vtb-bp1dudbh2d5na6b50****

The ID of the route table.

TransitRouterRouteTableName String testa

The name of the route table.

TransitRouterRouteTableStatus String Active

The state of the route table. Valid values:

  • Creating: The route table is being created.
  • Deleting: The route table is being deleted.
  • Active: The route table is available for use.
TransitRouterRouteTableType String System

The type of route table. Valid values:

  • Custom: a custom route table
  • System: the default route table

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListTransitRouterRouteTables
&TransitRouterId=tr-uf654ttymmljlvh2x****
&<Common request parameters>

Sample success responses

XML format

<ListTransitRouterRouteTablesTableResponse> 
  <TotalCount>2</TotalCount>
  <RequestId>2C89B67C-8EC6-46AF-9B2B-72A836A28F64</RequestId>
  <NextToken>dd20****</NextToken>
  <TransitRouterRouteTables>
        <TransitRouterRouteTableId>vtb-bp1dudbh2d5na6b50****</TransitRouterRouteTableId>
        <TransitRouterRouteTableStatus>Active</TransitRouterRouteTableStatus>
        <TransitRouterRouteTableType>System</TransitRouterRouteTableType>
        <TransitRouterRouteTableDescription>testb</TransitRouterRouteTableDescription>
        <CreateTime>2021-03-15T09:39Z</CreateTime>
        <TransitRouterRouteTableName>testa</TransitRouterRouteTableName>
  </TransitRouterRouteTables>
  <MaxResults>1</MaxResults>
</ListTransitRouterRouteTablesTableResponse>

JSON format

{
  "TotalCount": 2,
  "RequestId": "2C89B67C-8EC6-46AF-9B2B-72A836A28F64",
  "NextToken": "dd20****",
  "TransitRouterRouteTables": [
    {
      "TransitRouterRouteTableId": "vtb-bp1dudbh2d5na6b50****",
      "TransitRouterRouteTableStatus": "Active",
      "TransitRouterRouteTableType": "System",
      "TransitRouterRouteTableDescription": "testb",
      "CreateTime": "2021-03-15T09:39Z",
      "TransitRouterRouteTableName": "testa"
    }
  ],
  "MaxResults": 1
}

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 API Error Center.