Deletes an IPsec server.

Usage notes

  • The DeleteIpv6Gateway operation is asynchronous. After you send the request, the system returns a request ID. However, the operation is still being performed in the system background. You can call DescribeVpnGateway to query the status of a VPN gateway.
    • If a VPN gateway is in the updating state, the IPsec server is being deleted.
    • If a VPN gateway is in the active state, the IPsec server has been deleted.
  • You cannot repeatedly call DeleteIpsecServer to delete an IPsec server from a VPN gateway within the specified period of time.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DeleteIpsecServer

The operation that you want to perform. Set the value to DeleteIpsecServer.

RegionId String Yes cn-hangzhou

The ID of the region where the IPsec server is created.

IpsecServerId String Yes iss-bp1jougp8cfsbo8y9****

The ID of the IPsec server.

ClientToken String No 02fb3da4-130e-11e9-8e44-00****

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the value, but you must make sure that it is unique among different requests. The client 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 may be different for each API request.
DryRun String No false

Specifies whether only to precheck this request. Valid values:

  • true: only prechecks the request. After the request passes the precheck, the system does not delete the IPsec server. The system checks the required parameters, the request format, and the service limits. If the request fails the precheck, an error code is returned. If the request passes the precheck, the DryRunOperation error code is returned.
  • false (default): prechecks the request. After the request passes the precheck, the system deletes the IPsec server.

Response parameters

Parameter Type Example Description
RequestId String 0ED8D006-F706-4D23-88ED-E11ED28DCAC0

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DeleteIpsecServer
&IpsecServerId=iss-bp1jougp8cfsbo8y9****
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DeleteIpsecServerResponse>
<RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC0</RequestId>
</DeleteIpsecServerResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "0ED8D006-F706-4D23-88ED-E11ED28DCAC0"
}

Error codes

HttpCode Error code Error message Description
400 VpnGateway.Configuring The specified service is configuring. The error message returned because the specified service is being configured. Try again later.
403 Forbidden User not authorized to operate on the specified resource. The error message returned because you are unauthorized to perform this operation on the specified resource. Apply for the required permissions and try again.

For a list of error codes, visit the API Error Center.