List Transit Router Route Tables with ListTransitRouterRouteTables API - Cloud Enterprise Network - Alibaba Cloud - Cloud Enterprise Network

Queries the details of route tables of an Enterprise Edition transit router by calling the ListTransitRouterRouteTables operation.

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

cen:ListTransitRouterRouteTables

get

TransitRouterRouteTable

acs:cen:*:{#accountId}:centransitrouterroutetable/{#centransitrouterroutetableId}

TransitRouterRouteTable

acs:cen:*:{#accountId}:centransitrouterroutetable/*

TransitRouter

acs:cen:*:{#accountId}:centransitrouter/{#centransitrouterId}

None

Request parameters

Parameter	Type	Required	Description	Example
MaxResults	integer	No	The number of entries per page when entries are returned by page. Valid values: 1 to 100. Default value: 20.	20
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. Valid values: You do not need to specify this parameter for the first request or if no subsequent query exists. If a next query exists, set this parameter to the value of NextToken returned in the previous API call.	dd20****
TransitRouterRouteTableType	string	No	The type of the route table. Valid values: Custom: custom route table. System: system default route table.	Custom
TransitRouterId	string	No	The instance ID of the Enterprise Edition transit router.	tr-uf654ttymmljlvh2x****
TransitRouterRouteTableStatus	string	No	The status of the route table. Valid values: Creating: being created. Deleting: being deleted. Active: active.	Active
TransitRouterRouteTableNames	array	No	The name of the route table. You can query multiple route tables at a time. Maximum value of N: 20. Note If you specify both TransitRouterRouteTableNames.N and TransitRouterRouteTableIds.N, the route table names and route table IDs must correspond to each other.	testname
	string	No	The name of the route table. You can query multiple route tables at a time. Maximum value of N: 20. Note If you specify both TransitRouterRouteTableNames.N and TransitRouterRouteTableIds.N, the route table names and route table IDs must correspond to each other.	testname
TransitRouterRouteTableIds	array	No	The ID of the route table. You can query multiple route tables at a time. Maximum value of N: 20.	vtb-bp1l8awdb4iuo9uwu****
	string	No	The ID of the route table. You can query multiple route tables at a time. Maximum value of N: 20.	vtb-bp1dudbh2d5na6b50****
Tag	array<object>	No	The tag information. You can specify up to 20 tags at a time.
	object	No
Key	string	No	The tag key of the resource. Once specified, the tag key cannot be an empty string. The tag key can be up to 64 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`. You can specify up to 20 tag keys at a time.	test
Value	string	No	The tag value of the resource. The tag value can be an empty string or up to 128 characters in length. It cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`. Each tag key corresponds to one tag value. You can specify up to 20 tag values at a time.	test
RouteTableOptions	object	No	The route table feature options.
MultiRegionECMP	string	No	Multi-region equal-cost multi-path (ECMP) routing. Valid values: disable: Disables multi-region ECMP routing. After multi-region ECMP routing is disabled, routes with the same prefix learned from different regions select the transit router (TR) with the smallest Region ID (sorted alphabetically) as the next hop when other route attributes are the same. This changes the traffic latency and bandwidth consumed between different regions. Make sure that you fully evaluate the impact before disabling this feature. enable: Enables multi-region ECMP routing. After multi-region ECMP routing is enabled, routes with the same prefix learned from different regions form ECMP routes when other route attributes are the same. This changes the traffic latency and bandwidth consumed between different regions. Make sure that you fully evaluate the impact before enabling this feature. Valid values: disable : disable enable : enable	disable

Response elements

Element	Type	Description	Example
	object	The response parameters.
NextToken	string	The pagination token that is used in the next request to retrieve a new page of results. Valid values: If NextToken is empty, no next query exists. If NextToken is returned, the value indicates the token for the next query.	dd20****
RequestId	string	The request ID.	82678F4A-C9F7-4CC1-8BF0-D619A63BFC57
TotalCount	integer	The total number of entries returned.	1
MaxResults	integer	The number of entries per page when entries are returned by page.	20
TransitRouterRouteTables	array<object>	The list of route tables.
	array<object>
TransitRouterRouteTableStatus	string	The status of the route table. Creating: being created. Deleting: being deleted. Active: active.	Active
TransitRouterRouteTableType	string	The type of the route table. Custom: custom route table. System: system default route table.	System
CreateTime	string	The time when the route table was created. The time is displayed in UTC in the YYYY-MM-DDThh:mmZ format.	2021-03-15T09:39Z
TransitRouterRouteTableId	string	The route table ID.	vtb-bp1dudbh2d5na6b50****
TransitRouterRouteTableName	string	The name of the route table.	testname
TransitRouterRouteTableDescription	string	The description of the route table.	testdesc
Tags	array<object>	The list of tags.
	object
Key	string	The tag key.	test
Value	string	The tag value.	test
RouteTableOptions	object	The route table feature options.
MultiRegionECMP	string	Multi-region equal-cost multi-path (ECMP) routing. Valid values: disable: Disables multi-region ECMP routing. After multi-region ECMP routing is disabled, routes with the same prefix learned from different regions select the transit router (TR) with the smallest Region ID (sorted alphabetically) as the next hop when other route attributes are the same. This changes the traffic latency and bandwidth consumed between different regions. Make sure that you fully evaluate the impact before disabling this feature. enable: Enables multi-region ECMP routing. After multi-region ECMP routing is enabled, routes with the same prefix learned from different regions form ECMP routes when other route attributes are the same. This changes the traffic latency and bandwidth consumed between different regions. Make sure that you fully evaluate the impact before enabling this feature. Valid values: disable : disable enable : enable	disable
RegionId	string	The region ID of the Enterprise Edition transit router instance.	cn-beijing
TransitRouterId	string	The transit router instance ID.	tr-8vb8bie2koduo5awz****

Examples

Success response

JSON format

{
  "NextToken": "dd20****",
  "RequestId": "82678F4A-C9F7-4CC1-8BF0-D619A63BFC57",
  "TotalCount": 1,
  "MaxResults": 20,
  "TransitRouterRouteTables": [
    {
      "TransitRouterRouteTableStatus": "Active",
      "TransitRouterRouteTableType": "System",
      "CreateTime": "2021-03-15T09:39Z",
      "TransitRouterRouteTableId": "vtb-bp1dudbh2d5na6b50****",
      "TransitRouterRouteTableName": "testname",
      "TransitRouterRouteTableDescription": "testdesc",
      "Tags": [
        {
          "Key": "test",
          "Value": "test"
        }
      ],
      "RouteTableOptions": {
        "MultiRegionECMP": "disable"
      },
      "RegionId": "cn-beijing",
      "TransitRouterId": "tr-8vb8bie2koduo5awz****"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam.NextToken	NextToken is illegal	The error message returned because the NextToken parameter is set to an invalid value.
400	InvalidTransitRouterId.NotFound	TransitRouterId is not found.	The error message returned because the ID of the transit router does not exist.
400	IllegalParam.TagValue	The tag values are not valid.	The error message returned because the specified tag value is invalid.
400	IllegalParam.TagKey	The tag keys are not valid.	The error message returned because the specified tag key is invalid.
400	MissingParam.TransitRouterIdOrTransitRouterRouteTables	Either TransitRouterId or TransitRouterRouteTables must be specified.	The error message returned because you must set at least one of the TransitRouterId and TransitRouterRouteTables parameters.
400	InvalidName	Name is invalid.	The error message returned because the specified name is invalid.
400	InvalidParameter	Invalid parameter.	The error message returned because the parameter is set to an invalid value.
400	Unauthorized	The AccessKeyId is unauthorized.	The error message returned because you do not have the permissions to perform this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.