ListTransitRouterRouteTables - Cloud Enterprise Network - Alibaba Cloud Documentation Center

Queries the route tables of an Enterprise Edition transit router.

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

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
MaxResults	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 20.	20
NextToken	string	No	The token that determines the start point of the query. Valid values: If this is your first query or no subsequent query is to be sent, ignore this parameter. If a subsequent query is to be sent, set the value to the value of NextToken that is returned from the last call.	dd20****
TransitRouterRouteTableType	string	No	The type of the route table. Valid values: Custom: a custom route table System: the default route table	Custom
TransitRouterId	string	No	The ID of the Enterprise Edition transit router.	tr-uf654ttymmljlvh2x****
TransitRouterRouteTableStatus	string	No	The status of the route table. Valid values: Creating: The route table is being created. Deleting: The route table is being deleted. Active: The route table is available.	Active
TransitRouterRouteTableNames	array	No	The name of the route table. You can query multiple route tables in each call. Maximum value of N: 20. Note If you set both TransitRouterRouteTableNames.N and TransitRouterRouteTableIds.N, make sure that the specified name and ID belong to the same route table.
	string	No	The name of the route table. You can query multiple route tables in each call. Maximum value of N: 20. Note If you set both TransitRouterRouteTableNames.N and TransitRouterRouteTableIds.N, make sure that the specified name and ID belong to the same route table.	testname
TransitRouterRouteTableIds	array	No	The ID of the route table. You can query multiple route tables in each call. Maximum value of N: 20.
	string	No	The ID of the route table. You can query multiple route tables in each call. Maximum value of N: 20.	vtb-bp1dudbh2d5na6b50****
Tag	array<object>	No	The information about the tags. You can specify at most 20 tags in each call.
	object	No
Key	string	No	The tag key. The tag key cannot be an empty string. The tag key can be up to 64 characters in length and cannot start with `acs:` or `aliyun`. It cannot contain `http://` or `https://`. You can specify at most 20 tag keys.	test
Value	string	No	The tag value. The tag value can be 0 to 128 characters in length, and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`. Each tag key must have a unique tag value. You can specify at most 20 tag values in each call.	test
RouteTableOptions	object	No	The features of the route table.
MultiRegionECMP	string	No	Specifies whether to enable equal-cost multi-path (ECMP) routing. Valid values: disable: disables ECMP routing If you disable ECMP routing, routes that are learned from different regions but have the same prefix and attributes select the transit router with the smallest region ID as the next hop. Region IDs are sorted in alphabetic order. The network latency and bandwidth consumption also vary based on the region. Proceed with caution. enable: enables ECMP routing. If you enable ECMP routing, routes that are learned from different regions but have the same prefix and attributes form an ECMP route. The network latency and bandwidth consumption also vary based on the region. Proceed with caution.	disable

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
NextToken	string	The token that determines the start point of the next query. Valid values: If NextToken was returned in the previous query, specify the value to obtain the next set of results. If a value of NextToken is not returned, it indicates that no additional results exist.	dd20****
RequestId	string	The ID of the request.	82678F4A-C9F7-4CC1-8BF0-D619A63BFC57
TotalCount	integer	The total number of entries returned.	1
MaxResults	integer	The number of entries returned per page.	20
TransitRouterRouteTables	array<object>	A list of route tables.
TransitRouterRouteTable	object
TransitRouterRouteTableStatus	string	The status of the route table. Valid values: Creating Deleting Active	Active
TransitRouterRouteTableType	string	The type of the route table. Valid values: Custom System	System
CreateTime	string	The time when the route table was created. The time follows the ISO8601 standard in the YYYY-MM-DDThh:mmZ format. The time is displayed in UTC.	2021-03-15T09:39Z
TransitRouterRouteTableId	string	The ID of the route table.	vtb-bp1dudbh2d5na6b50****
TransitRouterRouteTableName	string	The name of the route table.	testname
TransitRouterRouteTableDescription	string	The description of the route table.	testdesc
Tags	array<object>	The tags.
Tag	object
Key	string	The tag key.	test
Value	string	The tag value.	test
RouteTableOptions	object	The features of the route table.
MultiRegionECMP	string	Indicates whether ECMP routing is enabled. Valid values: disable If ECMP routing is disabled, routes that are learned from different regions but have the same prefix and attributes select the transit router with the smallest region ID as the next hop. Region IDs are sorted in alphabetic order. The network latency and bandwidth consumption also vary based on the region. Proceed with caution. enable If ECMP routing is enabled, routes that are learned from different regions but have the same prefix and attributes form an ECMP route. The network latency and bandwidth consumption also vary based on the region. Proceed with caution.	disable
RegionId	string	The region ID of the Enterprise Edition transit router.	cn-beijing
TransitRouterId	string	The transit router ID.	tr-8vb8bie2koduo5awz****

Examples

Sample success responses

JSONformat

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

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

Change history

Change time	Summary of changes	Operation
2023-12-13	The Error code has changed	View Change Details
2023-10-18	The Error code has changed	View Change Details
2023-03-09	The Error code has changed. The response structure of the API has changed	View Change Details
2023-01-10	The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed	View Change Details