DescribeEnsRouteTables - ENS - 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:
- For mandatory resource types, indicate with a prefix of * .
- 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
ens:DescribeEnsRouteTables	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page.	30
RouteTableId	string	No	The ID of the route table.	vtb-5p1cifr72di****
NetworkId	string	No	The ID of the network.	n-257gqcdfvx6n****
EnsRegionId	string	No	The ID of the ENS node.	cn-xian-unicom
EnsRegionIds	array	No	The IDs of edge nodes. You can specify 1 to 100 IDs.
	string	No	The IDs of edge nodes.	cn-chengdu-telecom-4
Type	string	No	The SNAT type. FullCone: full cone NAT.	FullCone
AssociateType	string	No	The type of the resource with which the route table is associated. Valid values: VSwitch Gateway	Gateway
RouteTableName	string	No	The name of the route table.	tftest-nat04

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	DC51ACB0-460D-5CA0-BA2D-E1F3B5547AE9
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of entries returned.	10
PageSize	integer	The number of entries per page.	30
RouteTables	array<object>	The information about the route tables.
RouteTable	object	The information about the route table.
CreationTime	string	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.	2024-03-08T08:35:18Z
Status	string	The status. Valid values: Available: The route table is available.	Available
RouteTableId	string	The ID of the route table.	rt-5xde2bit9****
NetworkId	string	The ID of the network.	n-5v9lufsezl4g****
VSwitchIds	array	The vSwitches that are associated with the route table.
VSwitch	string	The vSwitch that is associated with the route table.	vsw-5f649tc4****
EnsRegionId	string	The ID of the edge node.	cn-beijing-15
Type	string	The type of the route table. Examples: Custom: custom route table. System: system route table.	System
RouteTableName	string	The name of the route table that you want to query. The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-).	test-tf-vtb7
AssociateType	string	The type of the resource with which the route table is associated. Valid values: VSwitch Gateway	VSwitch
Description	string	The description.	test
IsDefaultGatewayRouteTable	boolean	Specifies whether it is the default gateway route table.	false

Examples

Sample success responses

JSONformat

{
  "RequestId": "DC51ACB0-460D-5CA0-BA2D-E1F3B5547AE9",
  "PageNumber": 1,
  "TotalCount": 10,
  "PageSize": 30,
  "RouteTables": [
    {
      "CreationTime": "2024-03-08T08:35:18Z",
      "Status": "Available",
      "RouteTableId": "rt-5xde2bit9****",
      "NetworkId": "n-5v9lufsezl4g****",
      "VSwitchIds": [
        "vsw-5f649tc4****"
      ],
      "EnsRegionId": "cn-beijing-15",
      "Type": "System",
      "RouteTableName": "test-tf-vtb7",
      "AssociateType": "VSwitch",
      "Description": "test",
      "IsDefaultGatewayRouteTable": false
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	ens.interface.error	Failed to call API.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

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

Change history

Change time	Summary of changes	Operation
2025-03-13	The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2024-12-26	The Error code has changed. The request parameters of the API has changed	View Change Details