Bind HAVIP to ENS Instance or ENI for High Availability - ENS

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

Operation description

When you 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.

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

ens:AssociateHaVip

update

*HaVip

acs:ens::{#accountId}:havip/{#HaVipId}

None

Request parameters

Parameter	Type	Required	Description	Example
HaVipId	string	Yes	The ID of the HAVIP.	havip-5p14t****
InstanceId	string	Yes	The ID of the instance.	i-50c4****
InstanceType	string	No	The type of the instance to be associated with the HAVIP. Valid values: EnsInstance (default): ENS instance NetworkInterface: elastic network interface (ENI)	EnsInstance

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	CEF72CEB-54B6-4AE8-B225-F876FF7BA984

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InstanceNotFound	The input parameter instancdId that is not found.
400	Invalid%s	The specified parameter %s is invalid.
400	Missing%s	You must specify the parameter %s.
400	HaVipNotFound	The input parameter haVipId that is not found.	The specified HaVip does not exist.
400	IncorrectHaVipStatus	The status of the haVip is invalid.	HaVip status is incorrect
400	SystemError	Interface call error, please re-match, or contact the product.	Interface call error, please re-select
400	InstanceAlreadyAssociated	The instance is already bound.	The instance is already bound.
400	IncorrectNetworkInterfaceStatus	The 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.
400	NetworkInterfaceNotFound	The specified network interface does not exist.	The specified network interface does not exist.
400	NetworkInterfaceTypeNotSupported	This network interface type cannot be used with the current operation.	This network interface type cannot be used with the current operation.
400	IncorrectInstanceVSwitch	The binding instance must be under the same VSwitch.	The binding instance must be under the same VSwitch.
400	IncorrectInstanceStatus	The current status of the instance does not support this operation.	The instance is in a state that does not support the current operation.
400	CountLimitExceed.HaVipOnInstance	The amount of HaVip associated with the specified Instance reach its limits.	The amount of HaVip associated with the specified Instance reach its limits.
400	CountLimitExceed.InstanceOnHaVip	The number of instances bound to HaVip has reached the limit.	The number of instances bound to HaVip has reached the limit.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.