Use DescribeTransitRouteTableAggregation to query aggregate routes - Cloud Enterprise Network - Alibaba Cloud - Cloud Enterprise Network

Queries the aggregate routes in the route table of an Enterprise Edition transit router.

Operation description

You can query the information about a specific aggregate route by specifying the TransitRouteTableId and TransitRouteTableAggregationCidr parameters. If you specify only the TransitRouteTableId parameter, the system queries the information about all aggregate routes in the route table of the Enterprise Edition transit router by default.

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:DescribeTransitRouteTableAggregation

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TransitRouteTableId	string	Yes	The ID of the route table of the Enterprise Edition transit router.	vtb-6ehgc262hr170qgyc****
TransitRouteTableAggregationCidr	string	No	The destination CIDR block of the aggregate route.	192.168.10.0/24
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can generate the parameter value on your client to ensure that it is unique across different requests. The client token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the client token. The RequestId of each API request is different.	02fb3da4-130e-11e9-8e44-001****
MaxResults	integer	No	The number of entries to return on each page. Default value: 20.	20
NextToken	string	No	The token that is used for the next query. Valid values: If this is your first query or no next query is to be sent, ignore this parameter. If a next query is to be sent, set the value to the NextToken value returned from the last API call.	FFmyTO70tTpLG6I3FmYAXGKPd****

Response elements

Element	Type	Description	Example
	object	The returned results.
Data	array<object>	The list of aggregate routes.
	object	The aggregate route information.
Name	string	The name of the aggregate route.	nametest
TransitRouteTableAggregationCidr	string	The destination CIDR block of the aggregate route.	192.168.10.0/24
Scope	string	The propagation scope of the aggregate route. Valid value: VPC, which indicates that the aggregate route is propagated to all VPC-connected instances that are associated with the route table of the current Enterprise Edition transit router and have route synchronization enabled.	VPC
RouteType	string	The route type of the aggregate route. Valid value: Static, which indicates a static route. After the aggregate route is propagated to a VPC-connected instance, it becomes a custom route entry by default.	Static
Description	string	The description of the aggregate route.	desctest
TrRouteTableId	string	The ID of the route table of the Enterprise Edition transit router.	vtb-6ehgc262hr170qgyc****
Status	string	The propagation status of the aggregate route. AllConfigured: The aggregate route is delivered to all VPC-connected instances. Configuring: The aggregate route is being delivered. ConfigFailed: The aggregate route failed to be delivered. PartialConfigured: The aggregate route is not delivered to some VPC-connected instances. Deleting: The aggregate route is being deleted.	AllConfigured
ScopeList	array	The list of propagation scopes for the aggregate route. Note You must specify at least one of the propagation scope and the propagation scope list. We recommend that you specify the propagation scope list. The elements in the propagation scope list cannot be the same as the value of the propagation scope.
	string	The propagation scope of the aggregate route. Valid values: VPC: propagates the aggregate route to all VPC-connected instances that are associated with the route table of the current Enterprise Edition transit router and have route synchronization enabled. VBR: propagates the aggregate route to all virtual border router (VBR) instances that are attached to the current Enterprise Edition transit router. Peer: propagates the aggregate route to all transit routers that have established inter-region connections with the current Enterprise Edition transit router. VPN: propagates the aggregate route to all VPN instances that are attached to the current Enterprise Edition transit router. ECR: propagates the aggregate route to all Express Connect Router (ECR) instances that are attached to the current Enterprise Edition transit router.	VPC
Count	integer	The number of entries returned on each page.	20
NextToken	string	The token that is used for the next query. Valid values: If NextToken is empty, no next query is to be sent. If NextToken is returned, the value indicates the token that is used for the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
Total	integer	The total number of entries.	1
RequestId	string	The request ID.	0C2EE7A8-74D4-4081-8236-CEBDE3BBCF50

Examples

Success response

JSON format

{
  "Data": [
    {
      "Name": "nametest",
      "TransitRouteTableAggregationCidr": "192.168.10.0/24",
      "Scope": "VPC",
      "RouteType": "Static",
      "Description": "desctest",
      "TrRouteTableId": "vtb-6ehgc262hr170qgyc****",
      "Status": "AllConfigured",
      "ScopeList": [
        "VPC"
      ]
    }
  ],
  "Count": 20,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "Total": 1,
  "RequestId": "0C2EE7A8-74D4-4081-8236-CEBDE3BBCF50"
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParam.transitRouterRouteTableId	Missing the parameter transitRouter route table id.	The error message returned because the transitRouterRouteTableId parameter is not set.
400	IllegalParam.NextToken	The nextToken is illegal.	The error message returned because the NextToken parameter is set to an invalid value.
400	InstanceNotExist.TransitRouterRouteTable	The transitRouter route table is not found.	The TransitRouteTable does not exist.
400	InvalidCidrBlock	The transitRouteTableAggregationCidr is invalid.	The cidrBlock specified in the parameter 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.