All Products
Search

This Product

    Virtual Private Cloud:DeleteHaVip

    Document Center

    Virtual Private Cloud:DeleteHaVip

    Last Updated:Nov 13, 2024

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

    Operation description

    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

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    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 Resources is 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.
    OperationAccess levelResource typeCondition keyAssociated operation
    vpc:DeleteHaVipdelete
    • HaVip
      acs:vpc:{#regionId}:{#accountId}:havip/{#HaVipId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ClientTokenstringNo

    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.
    		0c593ea1-3bea-11e9-b96b-88e9fe637760
    RegionIdstringYes

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

    		cn-shanghai
    HaVipIdstringYes

    The ID of the HAVIP that you want to delete.

    		havip-2zeo05qre24nhrqpy****

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		C44F62BE-9CE7-4277-B117-69243F3988BF

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400IncorrectStatusHaVip 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.
    400DependencyViolation.HaVipReferedByRouteEntryHaVip cannot be deleted when it is refered by a route table entry as next hop.The HAVIP serves as the next hop of a route entry and cannot be deleted. You must delete the route entry before you can delete the HAVIP.
    400DependencyViolation.HaVipAssociatedWithEIPHaVip cannot be deleted when it is associated with EIP.The HAVIP is associated with an EIP and cannot be deleted.
    400IncorrectHaVipStatusHaVip?s status is invalid.-
    400Forbidden.HaVipNo 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.
    404InvalidRegionId.NotFoundThe RegionId provided does not exist in our records.The RegionId parameter is set to an invalid value. Specify a valid value and try again.
    404InvalidHaVipId.NotFoundThe 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.

    For a list of error codes, visit the Service error codes.