All Products
Search

This Product

    Virtual Private Cloud:UnassociateHaVip

    Document Center

    Virtual Private Cloud:UnassociateHaVip

    Last Updated:Mar 22, 2024

    Disassociates a high-availability virtual IP address (HAVIP) from an Elastic Compute Service (ECS) instance or an elastic network interface (ENI) in a virtual private cloud (VPC).

    Operation description

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

    • The ECS instance must be in the Running or Stopped state.

    • The HAVIP must be in the Available or InUse state.

    • UnassociateHaVip is an asynchronous operation. After a request is sent, the system returns a request ID and an instance ID and runs the task in the background. You can call the DescribeHaVips operation to query the status of an HAVIP:

      • If the HAVIP is in the Unassociating state, the HAVIP is being disassociated.
      • If the HAVIP is in the Inuse or Available state, the HAVIP is disassociated.

    • You cannot repeatedly call the UnassociateHaVip operation to disassociate 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.

    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:UnassociateHaVipWrite
    • Instance
      acs:vpc:{#regionId}:{#accountId}:instance/{#InstanceId}
    • 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 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.

    		0c593ea1-3bea-11e9-b96b-88e9fe63****
    RegionIdstringYes

    The region ID of the HAVIP.

    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 disassociate.

    		havip-2zeo05qre24nhrqpy****
    InstanceIdstringYes

    The ID of the ECS instance or ENI from which you want to disassociate the HAVIP.

    		i-faf344422ffsfad****
    ForcestringNo

    Specifies whether to forcefully disassociate the HAVIP from the ECS instance or ENI. Valid values:

    • True
    • False (default)
    Note If you set the value to False, you cannot disassociate the HAVIP from the primary instance.
    		True
    InstanceTypestringNo

    The type of the instance from which you want to disassociate the HAVIP. Valid values:

    • EcsInstance: an ECS instance
    • NetworkInterface: an ENI
    Note If you want to disassociate the HAVIP from an ENI, this parameter is required.
    		EcsInstance

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

    		C44F62BE-9CE7-4277-B117-69243F3988BF

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400IncorrectHaVipStatusHaVip can be operated by this action only when it's status is InUse.The operation can be performed only when the HAVIP is in the InUse state.
    400IncorrectInstanceStatusECS instance can be operated by this action only when it's status is Running or Stopped.You can do this operation only when the ECS instance is running or stopped.
    400ResourceNotAssociatedThe HaVip and ECS instance are not associated.The HAVIP is not bound to the ECS instance.
    400Forbidden.UnassociateMasterUnassociating a master instance is not allowed unless the parameter Force is True.You cannot disassociate the HAVIP from a primary instance when Force is set to False.
    400IncorrectHaVipStatusHaVip?s status is invalid.-
    400HA.VIP.NOT.ASSOCIATED.WITH.INSTANCEha vip not associated with instance.-
    400OperationFailed.DistibuteLockDistibute lock fail.-
    400OperationFailed.QueryNetworkInterfaceInfoFailed to query network interface information.The system failed to query ENI information.
    400IllegalParam.InstanceTypeThe specified instance type is invalid. Only ECS instances and network interface are allowed.The type of the associated instance does not support this operation.
    400InvalidNetworkInterfaceId.NotFoundThe network interface is not found.The ENI does not exist.
    400ResourceNotFound.InstanceThe specified binding resource is not found.-
    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.
    404InvalidInstanceId.NotFoundThe specified Instance does not exist in the specified region.The instance does not exist in the region.
    500InternalErrorThe request processing has failed due to some unknown error.An unknown error occurred.

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