Deletes a VPN gateway.
Operation description
Note
You cannot delete a VPN gateway associated with existing IPsec-VPN connections.
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:DeleteVpnGateway | delete |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID of the VPN gateway. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
| 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 and cannot exceed 64 characters in length. 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.
| 02fb3da4-130e-11e9-8e44-0016e04115b |
| VpnGatewayId | string | Yes | The ID of the VPN gateway. | vpn-bp1q8bgx4xnkm2ogj**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": ">0ED8D006-F706-4D23-88ED-E11ED28DCAC0"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | DependencyViolation.VpnConnection | There are vpn connections on specified customer gateway not deleted. | The error message returned because VPN connections to the specified customer gateway are not deleted. |
| 400 | DependencyViolation.SslVpnServer | There is SSL VPN server on specified vpn gateway not deleted. | The error message returned because SSL-VPN connections to the specified customer gateway are not deleted. |
| 400 | VpnGateway.Configuring | The specified service is configuring. | The service is being configured. Try again later. |
| 400 | VpnGateway.Configuring | The specified VPN gateway is being configured. | The VPN gateway is being configured. |
| 400 | DependencyViolation.GreTunnel | There is Gre tunnel on specified vpn gateway not deleted. | The error message returned because GRE tunnels are not deleted on the VPN gateway. |
| 400 | InternalError | The request processing has failed due to some unknown error, exception or failure. | An internal error occurred. |
| 400 | TaskConflict | The eip operate too frequent, TaskConflict. | Operations are too frequent and tasks conflict with each other. |
| 400 | InvalidVpnGatewayInstanceId.NotFound | The specified vpn gateway instance id does not exist. | The specified VPN gateway does not exist. Check whether the specified VPN gateway is valid. |
| 403 | Forbidden.SubUser | User not authorized to operate on the specified resource as your account is created by another user. | The error message returned because you are unauthorized to perform this operation on the specified resource. Acquire the required permissions and try again. |
| 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. |
| 403 | ForbiddenRelease | Forbidden to release a prepaid instance within validity period | You cannot release a subscription VPN gateway within the subscription duration. |
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 API operation is not deprecated.. The Error code has changed | View Change Details |