AssociateHaVip - Elastic Compute Service - Alibaba Cloud Documentation Center

Associates a high-availability virtual IP address (HaVip) with a specified instance.

Note

This API has been deprecated. We recommend migrating to Vpc(2016-04-28) - AssociateHaVip for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

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:AssociateHaVip

update

*Instance

acs:vpc:{#regionId}:{#accountId}:instance/{#InstanceId}

*HaVip

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

None

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No
RegionId	string	Yes
HaVipId	string	Yes
InstanceId	string	Yes

Response elements

Element	Type	Description	Example
	object
RequestId	string

Examples

Success response

JSON format

{
  "RequestId": ""
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidVip.Status	vip invalid status
400	IncorrectHaVipStatus	HaVip can be operated by this action only when it's status is Available or InUse.
400	IncorrectInstanceStatus	ECS instance can be operated by this action only when it??s status is Running or Stopped.
400	CountLimitExceed.HaVipOnInstance	The amount of HaVip associated with the specified Instance reach its limits.	The number of HAVIPs that are associated with the specified instance approaches the upper limit.
400	CountLimitExceeded.HaVipOnECSInstance	The amount of Instance associated with the specified HaVip reach its limits.	The maximum number of HAVIPs has been reached.
400	OperationFailed.DistibuteLock	Distibute lock fail.
400	Forbidden.HaVip	No permissions to perform operations on HAVIPs. Please apply for privilege--vpc_privilege_allow_buy_havip_instance.	You do not have the permissions to manage the HAVIP. Go to the Quota Center to apply for the permissions.
400	OperationUnsupported.BindMultipleType	You cannot bind HaVip to multiple instance types.
404	InvalidHaVip.Exist	haVip already bind exist.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	Region information error
404	InvalidHaVipId.NotFound	The specified HaVip does not exist in the specified region.
404	InvalidInstanceId.NotFound	The specified Instance does not exist in the specified region.	The specified instance does not exist. Check whether the instance ID is correct.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.