All Products
Search

This Product

    :AssociateHaVip

    Document Center

    :AssociateHaVip

    Last Updated:Dec 25, 2024

    Associates a high-availability virtual IP address (HAVIP) with an Edge Node Service (ENS) instance or elastic network interface (ENI).

    Operation description

    When you call this operation to associate an HAVIP, take note of the following items:

    • An HAVIP immediately takes effect after it is associated. You do not need to restart the ENS instance. However, you need to associate the HAVIP with the ENI of the ENS instance.

    • The HAVIP and ENS instance must belong to the same vSwitch.

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

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

    • AssociateHaVip is an asynchronous operation. After a request is sent, the system returns a request 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 Associating state, the HAVIP is being associated.
      • If the HAVIP is in the InUse state, the HAVIP is associated.

    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
    ens:AssociateHaVipupdate
    *HaVip
    acs:ens::{#accountId}:havip/{#HaVipId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    HaVipIdstringYes

    The ID of the HAVIP.

    		havip-5p14t****
    InstanceIdstringYes

    The ID of the instance.

    		i-50c4****
    InstanceTypestringNo

    The type of the instance to be associated with the HAVIP. Valid values:

    • EnsInstance (default): ENS instance.
    • NetworkInterface: ENI. If you want to associate the HAVIP with an ENI, this parameter is required.
    		EnsInstance

    Response parameters

    ParameterTypeDescriptionExample
    object

    Schema of Response

    RequestIdstring

    The request ID.

    		CEF72CEB-54B6-4AE8-B225-F876FF7BA984

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400InstanceNotFoundThe input parameter instancdId that is not found.-
    400Invalid%sThe specified parameter %s is invalid.-
    400Missing%sYou must specify the parameter %s.-
    400HaVipNotFoundThe input parameter haVipId that is not found.The specified HaVip does not exist.
    400IncorrectHaVipStatusThe status of the haVip is invalid.HaVip status is incorrect
    400SystemErrorInterface call error, please re-match, or contact the product.Interface call error, please re-select
    400InstanceAlreadyAssociatedThe instance is already bound.The instance is already bound.
    400IncorrectNetworkInterfaceStatusThe operation could not be completed because the status of the specified network interface is invalid for this action.The operation could not be completed because the status of the specified network interface is invalid for this action.
    400NetworkInterfaceNotFoundThe specified network interface does not exist.The specified network interface does not exist.
    400NetworkInterfaceTypeNotSupportedThis network interface type cannot be used with the current operation.This network interface type cannot be used with the current operation.
    400IncorrectInstanceVSwitchThe binding instance must be under the same VSwitch.The binding instance must be under the same VSwitch.
    400IncorrectInstanceStatusThe current status of the instance does not support this operation.The instance is in a state that does not support the current operation.
    400CountLimitExceed.HaVipOnInstanceThe amount of HaVip associated with the specified Instance reach its limits.The amount of HaVip associated with the specified Instance reach its limits.
    400CountLimitExceed.InstanceOnHaVipThe number of instances bound to HaVip has reached the limit.The number of instances bound to HaVip has reached the limit.
    400NoPermissionPermission denied.-
    400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

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