DescribeEnsRouteTables API Reference for ENS Route Tables - ENS

Queries route tables.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ens:DescribeEnsRouteTables

list

*All Resource

*

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 elements

Element	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.
	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.
	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

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.