Call the DeleteHaVip API to delete a high-availability virtual IP address (HaVip) - Virtual Private Cloud - Alibaba Cloud - Virtual Private Cloud

Operation description

Before you begin:

The HaVip must be in the available state before it can be deleted.
Make sure that no routes point to the HaVip that you want to delete.
Make sure that the HaVip that you want to delete is not associated with any elastic IP address (EIP).
The DeleteHaVip operation is asynchronous. After you send a request, the system returns a request ID. However, the HaVip is not yet deleted. The deletion task runs in the background. You can call DescribeHaVips to query the deletion status of the HaVip:
- If the HaVip is in the Deleting state, the HaVip is being deleted.
- If the specified HaVip cannot be found, the HaVip is deleted.
The DeleteHaVip operation does not support concurrent deletion of the same HaVip.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:DeleteHaVip

delete

*HaVip

acs:vpc:{#regionId}:{#accountId}:havip/{#HaVipId}

None

Request parameters

Parameter	Type	Required	Description	Example
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 ClientToken value can contain only ASCII characters. Note If you do not specify this parameter, the system uses the RequestId of the API request as the ClientToken. The RequestId may differ for each API request.	0c593ea1-3bea-11e9-b96b-88e9fe637760
RegionId	string	Yes	The region ID of the HaVip. You can call the DescribeRegions operation to query the most recent region list.	cn-shanghai
HaVipId	string	Yes	The ID of the HaVip that you want to delete.	havip-2zeo05qre24nhrqpy****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	C44F62BE-9CE7-4277-B117-69243F3988BF

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	IncorrectStatus	HaVip can be deleted only when it is status is Available.	Failed to delete the HAVIP. You can delete the HAVIP only when its status is available.
400	DependencyViolation.HaVipReferedByRouteEntry	HaVip cannot be deleted when it is refered by a route table entry as next hop.
400	DependencyViolation.HaVipAssociatedWithEIP	HaVip cannot be deleted when it is associated with EIP.
400	IncorrectHaVipStatus	HaVip?s status is invalid.
400	Forbidden.HaVip	No permissions to perform operations on HAVIPs. Please apply for privilege--vpc_privilege_allow_buy_havip_instance.	The error message returned because you do not have the permissions to manage the HAVIP. Go to the Quota Center page to acquire the permissions.
400	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.
404	InvalidHaVipId.NotFound	The specified HaVip does not exist in the specified region.	The specified HAVIP does not exist in the specified region. Check whether the specified region is correct.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.