Call the DescribeRouteTableList API to query route tables that meet the specified conditions.

Instructions

When multiple request parameters are passed in, the system queries based on these parameters and returns route tables that match all conditions. If no matching route tables are found, an empty value is returned.

If no optional parameters are passed in, the system queries based on the currently logged-in account and returns all route tables under that account.

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

The following only details request parameters specific to this API and key common parameters. More information can be found in Common parameters.

Action String required Example: DescribeRouteTableList

The interface name. The current API name is DescribeRouteTableList.

Version String required Example: 2020-04-01

The interface version. the current API version is 2020-04-01.

VpcId String optional Example: vpc-2fdz8g5nruzuo5oxru****

ID of the VPC to which the route table belongs.

You can call the DescribeVpcs API to query the VPC ID.

RouteTableId String optional Example: vtb-2fdzao4h726f45******

The ID of the route table to query.

AssociateType String optional Example: Subnet

Type of route table. Valid values:

Subnet: Subnet route table.

Gateway: Gateway route table.

RouteTableName String optional Example: test-route-table

The name of the route table to query.

ProjectName String optional Example: default

Name of the project to which the route table belongs.

TagFilters.N.Key String optional Example: k1

The tag key.

N represents the sequence number of a tag key. Values: 1-10.

Separate multiple tag keys with &. Multiple tag keys are combined using a logical AND operation, meaning the query returns route tables that have all the specified tag keys.

Duplicate values are not allowed.

TagFilters.N.Values.N String optional Example: v1

The tag value.

The first N specifies the serial number of a tag key. Valid values: 1–10.

The second N represents the serial number of the tag value. Valid values: 1–3. Multiple tag values under the same tag key are combined using a logical OR operation, meaning the query returns route tables that have any of the specified tag values for that key.

Separate multiple tag values with ampersands (&).

tip

If this parameter is passed in, TagFilters.N.Key must be passed in first.

Passing an empty string will return route tables with empty tag values.

PageNumber Integer optional Example: 1

Page number of the list. Default: 1.

tip

This parameter is scheduled for deprecation. We recommend using NextToken and MaxResults for pagination queries.

PageSize Integer optional Example: 20

The number of entries per page in a pagination query. Maximum: 100. Default: 20.

tip

This parameter is scheduled for deprecation. We recommend using NextToken and MaxResults for pagination queries.

NextToken String optional Example: caeba0bbb2be03f84eb48b699f0a****

The pagination token that is used to mark the position in pagination queries.

If left blank, the query starts from the beginning.

Provide the NextToken returned from a previous call to this API, the query continues from that pagination position.

MaxResults Integer optional Example: 50

The number of query results. Default: 10. Maximum: 100.

Response parameters

Only the response parameters specific to this API are listed below. More information, see Response structure.

RequestId String Example: 2021062415303301022514515207C4****

Request ID.

TotalCount Integer Example: 2

Total number of matching route tables.

tip

This parameter is scheduled for deprecation. It becomes meaningless when using NextToken and MaxResults for paginated queries.

PageNumber Integer Example: 1

The current page number.

tip

This parameter is scheduled for deprecation. We recommend using NextToken and MaxResults for pagination queries.

PageSize Integer Example: 10

The count of entries per page in the current pagination.

tip

This parameter is scheduled for deprecation. We recommend using NextToken and MaxResults for pagination queries.

NextToken String Example: caeba0bbb2be03f84eb48b699f0a****

The pagination token returned by this API call, which marks the position for the next query. An empty return indicates there is no next page.

RouterTableList Object[] Example: -

Detailed information of the route table.

AccountId String Example: 200000****

The ID of the account to which the route table belongs.

AssociateType String Example: Subnet

Type of route table.

Ipv4GatewayId String Example: ipv4gw-bp1fgnh68xyz9****

IPv4 gateway ID.

Ipv6GatewayId String Example: ipv6gw-fadfgegg******

IPv6 Gateway ID.

VpcId String Example: vpc-2fdz8g5nruzuo5oxru****

ID of VPC to which the route table belongs.

VpcName String Example: test

Name of the VPC.

RouteTableId String Example: vtb-2fdzao4h726f45******

Route table ID.

RouteTableName String Example: Test-route-table

Route table name.

Description String Example: Test route table

Description of the route table.

RouteTableType String Example: Custom

Type of route table.

Custom: Custom route table.

System: System route table.

SubnetIds String[] Example: subnet-2fdzbgudy248w5o****

List of subnets associated with the route table.

ProjectName String Example: default

Name of the project to which the route table belongs.

Tags Object[] Example: -

Tag information of the route table.

Key String Example: k1

The tag key.

Value String Example: v1

The tag value.

CreationTime String Example: 2021-09-01T19:38:31+08:00

Creation time of the route table.

UpdateTime String Example: 2021-09-01T19:38:31+08:00

Update time of route table.

Request examples

Response examples

Error codes

Status code	Error codes	Error message	Explain
400	DryRunOperation	Exception raised to indicate a successfully authorized action when the DryRun flag is set to true.	This request is set to DryRun. The action is authorized but not executed.
400	IdempotentParameterMismatch	Arguments on this idempotent request are inconsistent with arguments used in previous request(s).	The parameters of this idempotent request are inconsistent with those used in the previous request.
400	InvalidMaxResults.Malformed	The specified parameter MaxResults is malformed.	The number of query results is invalid.
400	InvalidNextToken.Malformed	The specified parameter NextToken is invalid.	NextToken is invalid for the query.
400	InvalidPage.Malformed	The specified page is malformed.	The specified pagination parameter is invalid.
400	InvalidParameter.ClientTokenMalformed	The specified parameter ClientToken is malformed.	The format of specified CientToken is invalid. It must not exceed 64 ASCII characters.
400	InvalidTag.Disorder	The specified index order of tag is malformed.	The index order format of the specified tag is invalid
400	InvalidTagFilter.Disorder	The specified index order of tag filter is malformed.	The index order format of the specified tag filter is invalid.
400	InvalidTagFilterKey.Malformed	The specified parameter tag filter key is invalid.	The tag filter key is invalid.
400	InvalidTagFilterValue.Malformed	The specified parameter tag filter value is invalid.	The tag filter value is invalid.
400	InvalidTagKey.Malformed	The specified parameter tag key is invalid.	The tag key is invalid.
400	InvalidTagValue.Malformed	The specified parameter tag value is invalid.	The tag value is invalid.
400	LimitExceeded.TagFilterKey	You've reached the limit on the number of tag keys that you can filter.	You have reached the maximum number of filter tag keys that can be specified in a single request.
400	LimitExceeded.TagFilterValue	You've reached the limit on the number of tag values that you can filter.	You have reached the maximum number of filter tag values that can be specified in a single request.
400	LimitExceeded.Tags	You've reached the limit on the number of tags that you can operate at one time.	You have reached the maximum number of tags that can be processed in a single request.
412	IdempotentProcessing	The request uses the same client token as a previous one that is still in process.	The idempotent request is in progress.

Virtual Private Cloud