Create a high-availability virtual IP address by calling CreateHaVip - Virtual Private Cloud - Alibaba Cloud - Virtual Private Cloud

Creates a high-availability virtual IP address (HAVIP).

Operation description

CreateHaVip is an asynchronous operation. The system returns the ID of the HAVIP, but the HAVIP is not yet created and the creation task is still running in the background. You can call DescribeHaVips to query the creation status of the HAVIP:

When the HAVIP is in the Creating state, the HAVIP is being created.
When the HAVIP is in the Available state, the HAVIP is created.

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

create

*HaVip

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

*VSwitch

acs:vpc:{#regionId}:{#accountId}:vswitch/{#VSwitchId}

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	No	The name of the HAVIP. The name must be 1 to 128 characters in length, and cannot start with `http://` or `https://`.	test
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can generate a parameter value on your client to ensure that the parameter value is unique across different requests. The client token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId of each API request is different.	0c593ea1-3bea-11e9-b96b-88e9fe637760
RegionId	string	Yes	The region where the HAVIP resides. You can call the DescribeRegions operation to obtain the region ID.	cn-hangzhou
VSwitchId	string	Yes	The ID of the vSwitch to which the HAVIP belongs.	vsw-asdfjlnaue4g****
IpAddress	string	No	The IP address of the HAVIP. The specified IP address must be an unoccupied IP address in the vSwitch CIDR block. If you do not specify this parameter, an unoccupied IP address is randomly allocated from the specified vSwitch.	192.XX.XX.10
Description	string	No	The description of the HAVIP. The description must be 1 to 255 characters in length, and cannot start with `http://` or `https://`.	This is my HaVip.
ResourceGroupId	string	No	The ID of the resource group to which the HAVIP belongs.	rg-acfmxazb4ph6aiy****
Tag	array<object>	No	The tags of the resource.
	object	No	The tag.
Key	string	No	The tag key of the resource. You can specify up to 20 tag keys. If you specify this parameter, you cannot enter an empty string. A tag key can be up to 128 characters in length. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceDept
Value	string	No	The tag value of the resource. You can specify up to 20 tag values. If you specify this parameter, you can enter an empty string. A tag value can be up to 128 characters in length. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceJoshua

Response elements

Element	Type	Description	Example
	object	The response information.
RequestId	string	The request ID.	C44F62BE-9CE7-4277-B117-69243F3988BF
IpAddress	string	The IP address of the HAVIP.	192.XX.XX.10
HaVipId	string	The ID of the HAVIP.	havip-2zeo05qre24nhrqpy****

Examples

Success response

JSON format

{
  "RequestId": "C44F62BE-9CE7-4277-B117-69243F3988BF",
  "IpAddress": "192.XX.XX.10",
  "HaVipId": "havip-2zeo05qre24nhrqpy****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDescription.Malformed	The specified Description is wrongly formed.	The error message returned because the Description parameter is set to an invalid value.
400	InvalidIPAddress.OutOfRange	The specified IPAddress is out of VSwitch CIDR.
400	InvalidIPAddress.NotAvailable	The specified IPAddress is not available because it is a system reserved IPAddress.
400	InvalidIPAddress.AlreadyUsed	The specified IPAddress is already used by other resource.
400	InvalidIPAddress.Malformed	The specified IPAddress is not a valid or strict address.	The specified IP address is invalid.
400	Abs.Vpc.InvalidName.Malformed	The specified Name is not valid.	The specified Name is invalid.
400	InvalidIPAddress.OutOfVswCIDR	The specified IPAddress is out of VSwitch CIDR.	The IP address does not fall within the CIDR block of the vSwitch.
400	InvalidIPAddress.AlreadyInUse	The specified IPAddress is already used by other resource.	The IP address is being used by other resources.
400	UnsupportedFeature.CloudBoxHaVip	The HAVIP feature is not supported in cloud box.	CloudBox does not support the creation of high-availability virtual IP addresses.
400	CountLimitExceed.HaVipInVpc	Specified Vpc exceeds the quota of max number of ha-vip count.
400	Forbidden.HaVip	No 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.
400	OperationDenied.InvalidIpReservedByVSwitch	The specified ip address is the reserved address of the switch.	the specified ip address is the reserved address of the switch
400	InvalidRegionId.NotFound	Specified value of "regionId" is not supported.
400	IllegalParam.ResourceGroupId	Invalid ResourceGroupld value.	The specified resource group is invalid or does not exist.
400	IncorrectStatus.VSwitch	The specified vSwitch status is invalid.	The virtual switch status is abnormal.
403	CountLimitExceed.HaVipInVpc	Specified Vpc exceeds the quota of max number of ha-vip count.
403	QuotaExceeded.HaVip	Living HaVip quota exceeded.
404	InvalidVSwitchId.NotFound	The specified VSwitch does not exist in the specified region.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.