CreateHaVip - Elastic Compute Service - Alibaba Cloud Documentation Center

Note

This API has been deprecated. We recommend migrating to Vpc(2016-04-28) - CreateHaVip 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:CreateHaVip

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No
RegionId	string	Yes
VSwitchId	string	Yes
IpAddress	string	No
Description	string	No

Response elements

Element	Type	Description	Example
	object
HaVipId	string
RequestId	string

Examples

Success response

JSON format

{
  "HaVipId": "",
  "RequestId": ""
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDescription.Malformed	The specified Description is wrongly formed.	The resource description is invalid. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
400	InvalidIPAddress.OutOfRange	The specified IPAddress is out of VSwitch CIDR.	The specified IP address does not fall within the CIDR block of the vSwitch.
400	InvalidIPAddress.NotAvailable	The specified IPAddress is not available because it is a system reserved IPAddress.	The specified IP address is reserved and unusable.
400	InvalidIPAddress.AlreadyUsed	The specified IPAddress is already used by other resource.	The specified IP address is being used by another resource.
400	InvalidIPAddress.Malformed	The specified IPAddress is not a valid or strict address.
400	InvalidVSwitch.NotFound	The specified VSwitch does not exist in the specified region.
400	InvalidPrivateIp.NotFound	The specified private ip is not exist in vswitch.
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.
403	CountLimitExceed.HaVipInVpc	Specified Vpc exceeds the quota of max number of ha-vip count.
403	QuotaExceeded.HaVip	Living HaVip quota exceeded.
404	InvalidRegionId.NotFound	Specified value of "regionId" is not supported.
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.