Adds a destination-based route for an IPsec-VPN connection.
Operation description
-
The IPsec-VPN connection must be associated with a transit router. For more information, see CreateTransitRouterVpnAttachment .
-
You cannot create a destination-based route whose destination CIDR block is 0.0.0.0/0.
-
Do not add a destination-based route whose destination CIDR block is 100.64.0.0/10, or a CIDR block that contains 100.64.0.0/10 or belongs to 100.64.0.0/10. Such a route will make the console fail to display the status of the IPsec-VPN connection or cause IPsec negotiation failures.
-
CreateVcoRouteEntry is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call DescribeVpnConnection to query the status of the task.
- If the IPsec-VPN connection is in the updating state, the destination-based route is being created.
- If the IPsec-VPN connection is in the attached state, the destination-based route is created.
-
You cannot repeatedly call CreateVcoRouteEntry within the specified period of time.
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 Resourcesis 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 |
|---|---|---|---|---|
| vpc:CreateVcoRouteEntry | Write |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The ID of the region where the IPsec-VPN connection is established. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
| VpnConnectionId | string | Yes | The ID of the IPsec-VPN connection. | vco-p0w2jpkhi2eeop6q6**** |
| RouteDest | string | Yes | The destination CIDR block of the destination-based route. | 192.168.10.0/24 |
| Weight | integer | Yes | The weight of the destination-based route. Valid values:
| 100 |
| NextHop | string | Yes | The next hop of the destination-based route. | vco-p0w2jpkhi2eeop6q6**** |
| Description | string | No | The description of the destination-based route. | desctest |
| OverlayMode | string | No | The tunneling protocol. Set the value to Ipsec, which specifies the IPsec tunneling protocol. | Ipsec |
| 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 request ID as the client token. The request ID may be different for each request.
| 123e4567-e89b-12d3-a456-4266**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"VpnConnectionId": "vco-p0w2jpkhi2eeop6q6****",
"RouteDest": "192.168.10.0/24",
"NextHop": "vco-p0w2jpkhi2eeop6q6****",
"Weight": 100,
"OverlayMode": "Ipsec",
"State": "published",
"CreateTime": 1658387202664,
"RequestId": "CFC4D13B-E680-3985-95B1-87AA155481DF",
"Description": "desctest"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | Resource.QuotaFull | The quota of resource is full | The resource quota is exhausted. |
| 400 | VpnConnection.Configuring | The specified service is configuring. | The service is being configured. Try again later. |
| 400 | VpnConnection.FinancialLocked | The specified service is financial locked. | The error message returned because the service is locked due to overdue payments. |
| 400 | VpnRouteEntry.AlreadyExists | The specified route entry is already exist. | The route already exists. |
| 400 | VpnRouteEntry.Conflict | The specified route entry has conflict. | Route conflicts exist. |
| 400 | VpnRouteEntry.ConflictSSL | The specified route entry has conflict with SSL client. | The route conflicts with the SSL client. |
| 400 | VpnRouteEntry.BackupRoute | Validate backup route entry failed. | Active/standby routes failed authentication. |
| 400 | InvalidNextHop.NotFound | The specified NextHop does not exist. | The specified next hop does not exist. |
| 400 | IllegalParam.RouteDest | The specified RouteDest is invalid | The destination address is invalid. |
| 400 | OperationFailed.InvalidCidrBlock | Operation failed because the specified network block is invalid. | The CIDR block is invalid. |
| 400 | QuotaExceeded.VpnRouteEntry | The number of route entries to the VPN gateway in the VPC routing table has reached the quota limit. | The number of route entries to the VPN gateway in the VPC routing table has reached the quota limit. |
| 400 | TaskConflict | The operation is too frequent, please wait a moment and try again. | Your requests are too frequent. Try again later. |
| 400 | Resource.QuotaFull | The resources you are operating have reached the upper limit of the quota. Please increase the quota or use other solutions to avoid it according to the VPN operation document. | The resources you are operating have reached the upper limit of the quota. Please refer to the VPN operation document to increase the quota or use other schemes to avoid it. |
| 400 | Resource.PbrRouteQuotaFull | The quota of Policy-based route is full. | Policy routing quota exceeded |
| 400 | CreatePbrRoutesQuotaFull.QuotaFull | The number of policy routes exceeds the quota limit. | The number of policy routes exceeds the quota limit. |
| 400 | CreateDbrRoutesQuotaFull.QuotaFull | The number of created destination routes exceeds the quota limit. | The number of created destination routes exceeds the quota limit. |
| 403 | Forbbiden.SubUser | User not authorized to operate on the specified resource. | The error message returned because you do not have the permissions to manage the resource. |
| 403 | Forbidden | User not authorized to operate on the specified resource. | You do not have the permissions to manage the specified resource. Apply for the permissions and try again. |
| 404 | InvalidVpnConnectionInstanceId.NotFound | The specified vpn connection instance id does not exist. | The specified vpn connection instance id does not exist. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2024-01-04 | API Description Update. The Error code has changed | see changesets | ||||||||||
|