Create an aggregate route with CreateTransitRouteTableAggregation - Cloud Enterprise Network - Alibaba Cloud - Cloud Enterprise Network

Creates an aggregate route.

Operation description

After you add an aggregate route to an Enterprise Edition transit router route table, the Enterprise Edition transit router propagates the aggregate route only to the route tables of VPC-connected instances that are associated with the current Enterprise Edition transit router route table and have route synchronization enabled.

Before creating an aggregate route, make sure that the following operations are completed. Otherwise, the Enterprise Edition transit router does not propagate the aggregate route to VPC instance route tables:

The VPC instance is associated with the Enterprise Edition transit router route table. For more information, see AssociateTransitRouterAttachmentWithRouteTable.
Route synchronization is enabled for the VPC instance. For more information, see CreateTransitRouterVpcAttachment.

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TransitRouteTableId	string	Yes	The ID of the Enterprise Edition transit router route table.	vtb-iq8qgruq1ry8jc7vt****
TransitRouteTableAggregationName	string	No	The name of the aggregate route. The name can be empty or 1 to 128 characters in length and cannot start with http:// or https://.	nametest
TransitRouteTableAggregationCidr	string	Yes	The destination CIDR block of the aggregate route. Note The following CIDR blocks are not supported: CIDR blocks that start with "0" or "100.64" Multicast addresses (224.0.0.1 to 239.255.255.254)	192.168.10.0/24
TransitRouteTableAggregationScope	string	No	The propagation scope of the aggregate route. Set the value to VPC, which indicates that the aggregate route is propagated to all VPC-connected instances that have established an associated forwarding relationship with the current Enterprise Edition transit router route table and have the route synchronization feature enabled.	VPC
TransitRouteTableAggregationScopeList	array	No	The propagation scope list of the aggregate route. Note You must specify at least one of the propagation scope and the propagation scope list. We recommend that you use the propagation scope list. The elements in the propagation scope list cannot duplicate the value of the propagation scope.
	string	No	The propagation scope list of the aggregate route. Valid values: VPC: propagates the aggregate route to all VPC-connected instances that have established an associated forwarding relationship with the current Enterprise Edition transit router route table and have the route synchronization feature enabled. VBR: propagates the aggregate route to VBR instances that are loaded to the current Enterprise Edition transit router. Peer: propagates the aggregate route to transit routers that have established inter-region connections with the current Enterprise Edition transit router. VPN: propagates the aggregate route to VPN instances that are loaded to the current Enterprise Edition transit router. ECR: propagates the aggregate route to ECR instances that are loaded to the current Enterprise Edition transit router.	VPC
TransitRouteTableAggregationDescription	string	No	The description of the aggregate route. The description can be empty or 1 to 256 characters in length and cannot start with http:// or https://.	desctest
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among 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 ClientToken. The RequestId may be different for each API request.	02fb3da4-130e-11e9-8e44-001****
DryRun	boolean	No	Specifies whether to perform a dry run. The dry run checks items such as permissions and instance status. Valid values: false (default): sends a normal request and directly creates the aggregate route after the request passes the check. true: sends a check request without creating the aggregate route. The check items include required parameters and request format. If the check fails, the corresponding error is returned. If the check succeeds, the error code `DryRunOperation` is returned.	false

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	0C2EE7A8-74D4-4081-8236-CEBDE3BBCF50

Examples

Success response

JSON format

{
  "RequestId": "0C2EE7A8-74D4-4081-8236-CEBDE3BBCF50"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidOperation.RegionNotSupport	The Operation is not Support in this region.	The error message returned because this operation is not supported in the specified region.
400	InstanceExist.AggregationRoute	This aggregation route is already created.	The error message returned because the aggregated route already exists.
400	InstanceNotExist.TransitRouteTable	The transitRouter route table is not exist.	The error message returned because the specified transit router route table does not exist.
400	IncorrectStatus.TransitRouteTable	The transitRouter route table is not in a valid state for the operation.	The error message returned because the status of the transit router route table does not support this operation. Try again later.
400	QuotaExceeded.AggregationRoute	The aggregation route count is over limit.	The error message returned because the number of aggregated routes has reached the upper limit.
400	InstanceNotExist.TransitRouter	The aggregation route is not exist.	The error message returned because the specified transit router does not exist.
400	OperationUnsupported.TransitRouterType	The operation is not supported because of the wrong transitRouter type.	The error message returned because this operation is not supported by the specified type of transit router.
400	IncorrectStatus.TransitRouter	The status of transitRouter is invalid.	The error message returned because the status of the transit router does not support this operation. Try again later.
400	OperationUnsupported.ServiceMode	The operation is not supported because of the wrong transitRouter service mode.	The error message returned because the transit router mode does not support this operation.
400	InvalidCidrBlock	The cidr block is invalid.	The error message returned because the specified CIDR block is invalid.
400	RouteConflict	The specified route already exists.	The specified route already exists.
400	InvalidOperation.InstanceNotSupportIPv6Route	The cen dose not support Ipv6 route.
400	IllegalParam.TransitRouteTableAggregationCidr	The param TransitRouteTableAggregationCidr is illegal.
400	MissingParameter.ScopeListOrScope	The input parameter TransitRouteTableAggregationScopeList or TransitRouteTableAggregationScope that is mandatory for processing this request is not supplied.	The input parameter TransitRouteTableAggregationScopeList or TransitRouteTableAggregationScope that is mandatory for processing this request is not supplied.
400	InvalidParameter.TransitRouteTableAggregationScope	TransitRouteTableAggregationScope is invalid.	The propagation scope of the aggregate route is illegal.
400	InvalidParameter.TransitRouteTableAggregationScopeList	TransitRouteTableAggregationScopeList is invalid.	TransitRouteTableAggregationScopeList is invalid.
400	MissingParam.TransitRouteTableAggregationScope	The parameter TransitRouteTableAggregationScope is mandatory.	The parameter TransitRouteTableAggregationScope is mandatory.
400	IllegalParam.TransitRouteTableAggregationScope	TransitRouteTableAggregationScope is invalid, valid value is VPC.	TransitRouteTableAggregationScope is invalid, valid value is VPC.
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.
400	InvalidParameter.TransitRouteTableId	The specified parameter TransitRouteTableId is invalid.	The parameter TransitRouteTableId entered is illegal.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.