Creates an aggregate route.
Operation description
After you add an aggregate route to a route table of an Enterprise Edition transit router, the Enterprise Edition transit router advertises its routes only to route tables of virtual private clouds (VPCs) that are associated with a route table of the Enterprise Edition transit router and have route synchronization enabled.
Perform the following operations before you create an aggregate route. Otherwise, the Enterprise Edition transit router does not advertise routes to VPC route tables:
- Associated forwarding is enabled between the VPCs and the Enterprise Edition transit router. For more information, see AssociateTransitRouterAttachmentWithRouteTable .
- Route synchronization is enabled for the VPCs. For more information, see CreateTransitRouterVpcAttachment .
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
cen:CreateTransitRouteTableAggregation | create |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
TransitRouteTableId | string | Yes | The ID of the route table of the Enterprise Edition transit router. | vtb-iq8qgruq1ry8jc7vt**** |
TransitRouteTableAggregationName | string | No | The name of the aggregate route. The name must be 1 to 128 characters in length, and can contain letters, digits, and the following special characters: , . ; / @ _ -. You can also leave the name empty. | nametest |
TransitRouteTableAggregationCidr | string | Yes | The destination CIDR block of the aggregate route. Note
The following CIDR blocks are not supported:
| 192.168.10.0/24 |
TransitRouteTableAggregationScope | string | Yes | The scope of networks that you want to advertise the aggregate route. Set the value to VPC, which specified that the aggregate route is advertised to VPCs that are in associated forwarding relationship with a route table of the Enterprise Edition transit router and have route synchronization enabled. | VPC |
TransitRouteTableAggregationDescription | string | No | The description of the aggregate route. The description must be 0 to 256 characters in length, and can contain letters, digits, and the following special characters: , . ; / @ _ -. | 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 token can contain only ASCII characters. Note
If you do not set this parameter, ClientToken is set to the value of RequestId. The value of RequestId for each API request may be different.
| 02fb3da4-130e-11e9-8e44-001**** |
DryRun | boolean | No | Specifies whether to perform a dry run. Valid values:
| false |
Response parameters
Examples
Sample success responses
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 | 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 |
---|---|---|
2024-01-18 | The Error code has changed | View Change Details |
2023-03-21 | The Error code has changed | View Change Details |