DescribeRouteTableList - Virtual Private Cloud - Alibaba Cloud Documentation Center

Queries route tables.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
vpc:DescribeRouteTableList	list	RouteTable acs:vpc:{#regionId}:{#accountId}:routetable/*	vpc:VRouter vpc:VBR	none

Request parameters

Parameter	Type	Required	Description	Example
RouterType	string	No	The ID of the resource group to which the route table to be queried belongs.	VRouter
RouterId	string	No	The region ID of the VPC to which the route table belongs. You can call the DescribeRegions operation to query the most recent region list.	vrt-bp1lhl0taikrteen8****
VpcId	string	No	The tags of the resource.	vpc-bp15zckdt37pq72****
RouteTableId	string	No	The tags.	vtb-bp145q7glnuzdvzu2****
RouteTableName	string	No	The key of tag N to add to the resource. You can specify up to 20 tag keys. The tag key cannot be an empty string. The tag key can be up to 128 characters in length. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	doctest
PageNumber	integer	No	The value of tag N to add to the resource. You can specify up to 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length. It cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`.	1
PageSize	integer	No	The type of the route table. System Custom	10
ResourceGroupId	string	No	The details of the route table.	rg-acfmxazb4ph****
RegionId	string	Yes	The number of entries per page.	ap-southeast-6
Tag	array<object>	No	The page number.
	object	No	The total number of entries returned.
Key	string	No	The detailed information about the route tables.	FinanceDept
Value	string	No	The ID of the VPC to which the route table belongs.	FinanceJoshua
RouteTableType	string	No	The time when the route table was created.	System

Response parameters

Parameter	Type	Description	Example
	object	The status of the route table. Valid values: Pending Available Deleting
RequestId	string	The ID of the vRouter to which the route table belongs.	DC668356-BCB4-42FD-9BC3-FA2B2E04B634
PageSize	integer	The type of the cloud resource with which the route table is associated. Valid values: VSwitch: vSwitch Gateway: IPv4 gateway	10
PageNumber	integer	The ID of the route table.	1
TotalCount	integer	The ID of the Alibaba Cloud account to which the route table belongs.	1
RouterTableList	array<object>	The description of the route table.
RouterTableListType	object	The type of the route table. Valid values: Custom System
VpcId	string	The ID of the resource group to which the route table belongs.	vpc-bp15zckdt37pq72****
CreationTime	string	The type of the router to which the route table belongs. Valid values: VRouter VBR	2021-08-22T10:40:25Z
Status	string	The name of the route table.	Available
RouterId	string	The tag added to the route table.	vrt-bp1lhl0taikrteen8****
AssociateType	string	The tags.	VSwitch
RouteTableId	string	The key of tag N added to the resource.	vtb-bp145q7glnuzdvzu2****
OwnerId	long	The value of tag N added to the resource.	253460731706911258
Description	string	The information about the vSwitches.	This is Route Table.
RouteTableType	string	The ID of the vSwitch.	System
ResourceGroupId	string	The detailed information about the IPv4 gateway.	rg-acfmxazb4ph****
RouterType	string	The detailed information about the IPv4 gateway.	VRouter
RouteTableName	string	The name of the route table.	doctest
Tags	array<object>	The tags.
Tag	object	The tags.
Key	string	The key of tag N to add to the resource. You can specify up to 20 tag keys. The tag key cannot be an empty string. The tag key can be up to 128 characters in length. It cannot start with aliyun or acs:, and cannot contain http:// or https://.	type
Value	string	The value of tag N to add to the resource. You can specify up to 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length. It cannot start with aliyun or acs: and cannot contain http:// or https://.	ingress
VSwitchIds	array	The vSwitch IDs.
VSwitchId	string	The vSwitch IDs.	vsw-bp12mw1f8k3jgygk9****
GatewayIds	array	The detailed information about the IPv4 gateway.
GatewayIds	string	The detailed information about the IPv4 gateway.	ipv4gw-5tsnc6s4ogsedtp3k****
RoutePropagationEnable	boolean	Whether to receive the propagation routes. Valid Values: True: The propagation route is received. False: The propagation route is not received.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "DC668356-BCB4-42FD-9BC3-FA2B2E04B634",
  "PageSize": 10,
  "PageNumber": 1,
  "TotalCount": 1,
  "RouterTableList": {
    "RouterTableListType": [
      {
        "VpcId": "vpc-bp15zckdt37pq72****",
        "CreationTime": "2021-08-22T10:40:25Z",
        "Status": "Available",
        "RouterId": "vrt-bp1lhl0taikrteen8****",
        "AssociateType": "VSwitch",
        "RouteTableId": "vtb-bp145q7glnuzdvzu2****",
        "OwnerId": 253460731706911260,
        "Description": "This is Route Table.",
        "RouteTableType": "System",
        "ResourceGroupId": "rg-acfmxazb4ph****",
        "RouterType": "VRouter",
        "RouteTableName": "doctest",
        "Tags": {
          "Tag": [
            {
              "Key": "type",
              "Value": "ingress"
            }
          ]
        },
        "VSwitchIds": {
          "VSwitchId": [
            "vsw-bp12mw1f8k3jgygk9****"
          ]
        },
        "GatewayIds": {
          "GatewayIds": [
            "ipv4gw-5tsnc6s4ogsedtp3k****"
          ]
        },
        "RoutePropagationEnable": true
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidTagKey	The tag keys are not valid.	The tag index is invalid.
400	InvalidTagValue	The tag values are not valid.	The tag value is invalid.
400	IellgalParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.	The specified parameter OwnerAccount is illegal.
403	Forbbiden	User not authorized to operate on the specified resource.	User not authorized to operate on the specified resource.
403	Abs.InvalidPayType	Specified pay type is not valid.	-
403	Abs.InstanceNotExist	Specified instance not exist.	-
403	Abs.Forbidden	Specified instance cannot change pay type.	-
403	Abs.InvalidPayPeriod	Specified pay period not valid.	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-01-05	The Error code has changed. The response structure of the API has changed	View Change Details
2023-11-27	The Error code has changed. The request parameters of the API has changed	View Change Details
2023-08-14	The Error code has changed	View Change Details
2023-08-03	API Description Update. The Error code has changed. The request parameters of the API has changed	View Change Details