Call AllocateEipAddress to apply for an elastic IP address - Elastic IP Address - Alibaba Cloud - Elastic IP Address

Applies for an elastic IP address (EIP).

Operation description

Make sure that you are familiar with the billing methods and pricing of EIPs before you call this operation. For more information, see Billing overview.

After you call this operation, an EIP in the Available state is randomly allocated in the specified region. EIPs support only ICMP, TCP, and UDP at the transport layer. IGMP and SCTP are not supported.

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

create

*Address

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the EIP. You can call the DescribeRegions operation to query the region ID. Valid values: cn-beijing : cn-beijing	cn-hangzhou
Bandwidth	string	No	The maximum bandwidth of the EIP. Unit: Mbit/s. When InstanceChargeType is set to PostPaid and InternetChargeType is set to PayByBandwidth, valid values of Bandwidth are 1 to 500. When InstanceChargeType is set to PostPaid and InternetChargeType is set to PayByTraffic, valid values of Bandwidth are 1 to 200. When InstanceChargeType is set to PrePaid, valid values of Bandwidth are 1 to 1000. Default value: 5 Mbit/s.	5
Period	integer	No	The subscription duration. When PricingCycle is set to Month, valid values of Period are 1 to 9. When PricingCycle is set to Year, valid values of Period are 1 to 5. This parameter is required when InstanceChargeType is set to PrePaid. This parameter is not required when InstanceChargeType is set to PostPaid.	1
ISP	string	No	The line type. Valid values: BGP (default): BGP (multi-ISP) line. All regions support BGP (multi-ISP) EIPs. BGP_PRO: BGP (multi-ISP) Pro line. Only Hong Kong (China), Singapore, Tokyo (Japan), Kuala Lumpur (Malaysia), Manila (Philippines), Jakarta (Indonesia), and Bangkok (Thailand) regions support BGP (multi-ISP) Pro EIPs. For more information about BGP (multi-ISP) and BGP (multi-ISP) Pro lines, see EIP line types. If you are a whitelist user of single-ISP bandwidth, you can also select the following types: ChinaTelecom: China Telecom ChinaUnicom: China Unicom ChinaMobile: China Mobile ChinaTelecom_L2: China Telecom L2 ChinaUnicom_L2: China Unicom L2 ChinaMobile_L2: China Mobile L2 If you are a China (Hangzhou) Finance Cloud user, this parameter is required and must be set to BGP_FinanceCloud.	BGP
ActivityId	integer	No	The special activity ID. You do not need to configure this parameter.	123456
Netmode	string	No	The network type. The value is public (default), which specifies the public network.	public
AutoPay	boolean	No	Specifies whether to enable automatic payment. Valid values: false (default): Automatic payment is disabled. After an order is generated, go to the Order Center to complete the payment. true: Automatic payment is enabled. The order is automatically paid. This parameter is required when InstanceChargeType is set to PrePaid. This parameter is optional when InstanceChargeType is set to PostPaid.	false
PricingCycle	string	No	The billing cycle of the subscription. Valid values: Month (default): billed on a monthly basis. Year: billed on a yearly basis. This parameter is required when InstanceChargeType is set to PrePaid. This parameter is optional when InstanceChargeType is set to PostPaid.	Month
InstanceChargeType	string	No	The billing method of the EIP. Valid values: PrePaid: subscription. PostPaid (default): pay-as-you-go. When InstanceChargeType is set to PrePaid, InternetChargeType must be set to PayByBandwidth. When InstanceChargeType is set to PostPaid, InternetChargeType can be set to PayByBandwidth or PayByTraffic.	PostPaid
InternetChargeType	string	No	The metering method of the EIP. Valid values: PayByBandwidth (default): pay-by-bandwidth. PayByTraffic: pay-by-data-transfer. When InstanceChargeType is set to PrePaid, InternetChargeType must be set to PayByBandwidth. When InstanceChargeType is set to PostPaid, InternetChargeType can be set to PayByBandwidth or PayByTraffic.	PayByTraffic
ResourceGroupId	string	No	The resource group ID.	rg-acfmxazffggds****
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. Generate a parameter value from your client to ensure uniqueness across different requests. ClientToken supports only ASCII characters. Note If you do not specify this parameter, the system uses the RequestId of the API request as the ClientToken. The RequestId may differ for each API request.	0c593ea1-3bea-11e9-b96b-88e9fe637760
Name	string	No	The name of the EIP instance. The name must be 0 to 128 characters in length and cannot start with `http://` or `https://`. Note This parameter is not supported when you create a subscription EIP instance.	EIP1
Description	string	No	The description of the EIP instance. The description must be 0 to 256 characters in length and cannot start with `http://` or `https://`. Note This parameter is not supported when you create a subscription EIP instance.	test
SecurityProtectionTypes	array	No	The security protection level. If this parameter is left empty, the default value is Anti-DDoS Origin Basic. If this parameter is set to AntiDDoS_Enhanced, Anti-DDoS Origin Enterprise is used. You can specify at most one security protection level.	AntiDDoS_Enhanced
	string	No	The security protection level. If this parameter is left empty, the default value is Anti-DDoS Origin Basic. If this parameter is set to AntiDDoS_Enhanced, Anti-DDoS Origin Enterprise is used.	AntiDDoS_Enhanced
PublicIpAddressPoolId	string	No	The ID of the IP address pool. The EIP is allocated from the specified IP address pool. The IP address pool feature is not available by default. To use this feature, apply for the IP address pool privilege quota in Quota Center. For more information, see Increase a quota in Quota Center.	pippool-2vc0kxcedhquybdsz****
Zone	string	No	The zone of the EIP. When the IP address pool specified by PublicIpAddressPoolId is of the CloudBox type, this parameter defaults to the zone of the IP address pool. For information about how to view the business type of an IP address pool, see ListPublicIpAddressPools.	ap-southeast-1-lzdvn-cb
IpAddress	string	No	The IP address of the EIP that you want to apply for. You need to specify only one of IpAddress and InstanceId. If neither is specified, the system randomly allocates an EIP.	192.0.XX.XX
InstanceId	string	No	The instance ID of the EIP that you want to apply for. You need to specify only one of IpAddress and InstanceId. If neither is specified, the system randomly allocates an EIP.	eip-25877c70gddh****
Tag	array<object>	No	The tags of the resource.
	object	No
Key	string	No	The tag key of the resource. You can specify up to 20 tag keys. The tag key cannot be 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://`.	TestKey
Value	string	No	The tag value. Specify the value in the Tag.N.Value format. Valid values of N: 1 to 20. The tag value cannot be an empty string. The 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 parameters.
RequestId	string	The request ID.	4EC47282-1B74-4534-BD0E-403F3EE64CAF
OrderId	integer	The order ID. This parameter is returned when InstanceChargeType (the billing method of the EIP) is set to PrePaid (subscription). If AutoPay (automatic payment) is not enabled, go to the Order Center to complete the payment.	10
ResourceGroupId	string	The resource group ID. This parameter is returned only when InstanceChargeType is set to PostPaid.	rg-acfmxazfdgdg****
EipAddress	string	The allocated EIP. This parameter is returned only when InstanceChargeType is set to PostPaid.	192.0.XX.XX
AllocationId	string	The ID of the EIP instance.	eip-25877c70gddh****

Examples

Success response

JSON format

{
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "OrderId": 10,
  "ResourceGroupId": "rg-acfmxazfdgdg****",
  "EipAddress": "192.0.XX.XX",
  "AllocationId": "eip-25877c70gddh****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	QuotaExceeded.Eip	Elastic IP address quota exceeded
400	InsufficientBalance	Your account does not have enough balance.
400	InvalidParameter	Specified value of "InternetChargeType" is not valid
400	ReserveIpFail	Reserve eip failed.
400	InvalidRegion.NotSupport	The specified region does not support.
400	InvalidBandwidth.Malformed	The specified Bandwidth is invalid.
400	INSTANCE_TYPE_NOT_SUPPORT	The instance type is invalid.
400	QueryParameter.Illegal	query parameter illegal
400	QuotaExceeded.LargeSpecEip	Elastic IP address with large spec quota exceeded.
400	InvalidResourceGroupId	The specified ResourceGroupId does not exist.	The specified resource group ID does not exist.
400	OperationFailed.InsufficientEIP	Eip resource is not enough.
400	FrequentPurchase.EIP	eip frequent purchase
400	IellgalParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.	The specified parameter OwnerAccount is illegal.
400	ResourceNotFound.PublicIpAddressPool	The specified resource of PublicIpAddressPool is not found.
400	ResourceNotEnough.PublicIpAddressPool	The specified resource of PublicIpAddressPool is not enough.
400	Mismatch.IpAndPublicIpAddressPool	The Ip and PublicIpAddressPool are mismatched.
400	OperationDenied.NotOpenDdosOriginProtectService	The operation is not allowed because of you do not open Ddos Origin Protection Service	You can not create an anti-DDoS Enhanced EIP because you do not open Ddos Origin Protection Service.
400	IncorrectStatus.PublicIpAddressPool	The status of PublicIpAddressPool is incorrect.	EIPs are not allowed to be allocated because the address pool is in an unstable state.
400	IllegalParam.Isp	The param of %s is illegal.	The EIP cannot be allocated because the ISP is invalid.
400	ExclusiveParam.ZoneAndPublicIpAddressPoolId	The Zone and PublicIpAddressPoolId parameters are mutually exclusive.	You cannot specify Zone and PublicIpAddressPoolId at the same time.
400	IllegalParam.Zone	The specified zone is invalid.	Zone is set to an invalid value.
400	OperationFailed.AllocateUnfamiliarIp	The operation failed because only IP addresses used within the last seven days can be allocated.	Only IP addresses used within the last seven days can be used to apply for EIP.
400	Ip.Allocated	The reserve ip has been allocated.	Reserved IP addresses are already specified.
400	IncorrectStatus.Ip	The status of ip is incorrect.	The status of the IP is incorrect.
400	UnsupportedFeature.AllocateEipAddressWithZone	The feature of AllocateEipAddressWithZone is not supported.	You are not allowed to create an instance in a specified zone in the region.
400	ResourceNotFound.Ip	The specified ip is not found.	The specified IP could not be found.
400	OperationFailed.ResourceNotEnough	The resources you have applied for are insufficient.	The resources you have applied for are insufficient. If you still need to apply, please submit a work order for processing.
400	IllegalParam.Bandwidth	The param of bandwidth is illegal.	The Bandwidth parameter is set to an invalid value.
400	OperationFailed.IpIsLocked	The operation is failed because of ip is locked.	Your application failed because the IP address is locked.
400	Mismatch.EipSecurityProtectionTypeAndPoolSecurityProtectionType	The EipSecurityProtectionType and PoolSecurityProtectionType are mismatched.	The EIP protection type does not match the address pool protection type.
400	IllegalParam.SecurityProtectionTypes	The param of securityProtectionTypes is illegal.	The passed-in SecurityProtectionTypes parameter is invalid.
400	IllegalParam.ServiceLocation	The param of serviceLocation is illegal.	The param of serviceLocation is illegal.
400	UnsupportedFeature.Isp	The feature of Isp is not supported.	The ISP you specified is not currently supported.
400	ExclusiveParam.ZoneAndIpAddress	The specified param Zone and IpAddress or InstanceId are mutually exclusive.	The specified input zone conflicts with the IpAddress or InstanceId
400	InvalidDescription.Malformed	The Description is illeagl.	The specified resource description is invalid. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
400	InvalidName.Malformed	The attribute name is illegal.	The value of the Name parameter is invalid.
400	OperationFailed.UpgradeCdtServiceFirst	The operation is failed because of cdt is not upgraded.	The instance type you specified to purchase needs to be upgraded to CDT billing. Upgrade CDT and try again
400	OperationFailed.TokenExpired	The operation is failed because of TokenExpired.	the specified eip allocation token has expired
403	Forbidden	User not authorized to operate on the specified resource.	You do not have the permissions to manage the specified resource. Apply for the permissions and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.