Deletes a high-availability virtual IP address (HAVIP).

Usage notes

When you call this operation, take note of the following rules:

  • You can delete only HAVIPs that are in the Available state.
  • Make sure that no route points to the HAVIP that you want to delete.
  • Make sure that no elastic IP address (EIP) is associated with the HAVIP that you want to delete.
  • The DeleteHaVip 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 the DescribeHaVips operation to query the status of an HAVIP:
    • If the HAVIP is in the Deleting state, the HAVIP is being deleted.
    • If you cannot query the HAVIP, the HAVIP is deleted.
  • You cannot repeatedly call the DeleteHaVip operation to delete an HAVIP 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 DeleteHaVip

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

ClientToken String No 0c593ea1-3bea-11e9-b96b-88e9fe637760

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, the system uses RequestId as ClientToken. The value of RequestId in each API request may be different.
RegionId String Yes cn-shanghai

The ID of the region where the HAVIP is deployed. You can call the DescribeRegions operation to query the most recent region list.

HaVipId String Yes havip-2zeo05qre24nhrqpy****

The ID of the HAVIP that you want to delete.

Response parameters

Parameter Type Example Description
RequestId String C44F62BE-9CE7-4277-B117-69243F3988BF

The ID of the request.

Examples

Sample requests

https://vpc.aliyuncs.com/?Action=DeleteHaVip 
&HaVipId=havip-2zeo05qre24nhrqpy****
&RegionId=cn-shanghai 
&Common request parameters

Sample success responses

XML format 

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

<DeleteHaVipResponse> 
<RequestId>C44F62BE-9CE7-4277-B117-69243F3988BF</RequestId> 
</DeleteHaVipResponse>

JSON format 

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

{
  "RequestId" : "C44F62BE-9CE7-4277-B117-69243F3988BF"
}

Error codes

HttpCode Error code Error message Description
400 IncorrectStatus HaVip can be deleted only when it is status is Available. The error message returned because the HAVIP cannot be deleted. The error message returned because the HAVIP is not in the Available state.
400 DependencyViolation.HaVipReferedByRouteEntry HaVip cannot be deleted when it is refered by a route table entry as next hop. The error message returned because the HAVIP functions as the next hop of a route entry and cannot be deleted. You must delete the route entry before you can delete the HAVIP.
400 DependencyViolation.HaVipAssociatedWithEIP HaVip cannot be deleted when it is associated with EIP. The error message returned because the HAVIP is associated with an elastic IP address (EIP) and cannot be deleted.
404 InvalidHaVipId.NotFound The specified HaVip does not exist in the specified region. The error message returned because the specified HAVIP does not exist in the specified region. Check whether the region ID is valid.

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