Associates a high-availability virtual IP address (HAVIP) with an Elastic Compute Service (ECS) instance in a virtual private cloud (VPC).
When you call this operation, note that:
- The HAVIP takes effect immediately after it is associated with an ECS instance in a VPC. You do not need to restart the ECS instance. However, you must configure the HAVIP on the instance network interface controller (NIC).
- The HAVIP and ECS instance must belong to the same VSwitch.
- You can associate an HAVIP with at most two ECS instances.
- The ECS instance must be in the Running or Stopped state.
- The HAVIP must be in the Available or InUse state.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | AssociateHaVip |
The operation that you want to perform. Set the value to AssociateHaVip. |
HaVipId | String | Yes | havip-2zeo05qre24nhrqpy**** |
The ID of the HAVIP to be associated with the ECS instance. |
InstanceId | String | Yes | i-faf344422ffsfad**** |
The ID of the ECS instance to be associated with the HAVIP. |
RegionId | String | Yes | cn-shanghai |
The region ID of the HAVIP. You can call the DescribeRegions operation to query region IDs. |
ClientToken | String | No | 0c593ea1-3bea-11e9-b96b-88e9fe637760 |
The client token that is used to guarantee the idempotence of the request. You can use the client to generate a value that is unique among different requests. ClientToken supports only ASCII characters. It can contain up to 64 ASCII characters. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | C44F62BE-9CE7-4277-B117-69243F3988BF |
The request ID. |
Examples
Sample requests
https://vpc.aliyuncs.com/?Action=AssociateHaVip
&HaVipId=havip-2zeo05qre24nhrqpy****
&InstanceId=i-faf344422ffsfad****
&RegionId=cn-shanghai
&<Common request parameters>
Sample success responses
XML
format
<AssociateHaVipResponse>
<RequestId>C44F62BE-9CE7-4277-B117-69243F3988BF</RequestId>
</AssociateHaVipResponse>
JSON
format
{
"RequestId": "C44F62BE-9CE7-4277-B117-69243F3988BF"
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
404 | InvalidHaVipId.NotFound | The specified HaVip does not exist in the specified region. | The error message returned because the HAVIP does not exist in the specified region. Check whether the region is correct. |
404 | InvalidInstanceId.NotFound | The specified Instance does not exist in the specified region. | The error message returned because the instance does not exist in the specified region. |
400 | IncorrectHaVipStatus | HaVip can be operated by this action only when it's status is Available or InUse. | The error message returned because this operation can be performed only when the HAVIP is in the Available or InUse state. |
400 | CountLimitExceed.HaVipOnInstance | The amount of HaVip associated with the specified Instance reach its limits. | The error message returned because the number of HAVIPs exceeds the quota of the instance. |
400 | CountLimitExceeded.HaVipOnECSInstance | The amount of Instance associated with the specified HaVip reach its limits. | The error message returned because the number of HAVIPs exceeds the quota of the instance. |
For a list of error codes, visit the API Error Center.