Call AllocateEipAddressPro to request a specified IP address - Elastic IP Address - Alibaba Cloud - Elastic IP Address

Allocates a specified elastic IP address (EIP) for specific network configuration requirements.

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

create

*Address

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the EIP to allocate. You can call the DescribeRegions operation to query region IDs.	cn-hangzhou
IpAddress	string	No	The IP address of the EIP to allocate. You need to specify only one of the IpAddress and InstanceId parameters. If neither is specified, the system randomly allocates an EIP.	192.0.XX.XX
InstanceId	string	No	The instance ID of the EIP to allocate. You need to specify only one of the IpAddress and InstanceId parameters. If neither is specified, the system randomly allocates an EIP.	eip-25877c70gddh****
Bandwidth	string	No	The maximum bandwidth of the EIP to allocate. Unit: Mbit/s. If InstanceChargeType is set to PostPaid and InternetChargeType is set to PayByBandwidth, valid values of Bandwidth are 1 to 500. If InstanceChargeType is set to PostPaid and InternetChargeType is set to PayByTraffic, valid values of Bandwidth are 1 to 200. If 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. If PricingCycle is set to Month, valid values of Period are 1 to 9. If PricingCycle is set to Year, valid values of Period are 1 to 3. This parameter is required if InstanceChargeType is set to PrePaid. Do not set this parameter if 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, Malaysia (Kuala Lumpur), Philippines (Manila), Indonesia (Jakarta), and Thailand (Bangkok) 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. Set the value to BGP_FinanceCloud.	BGP
Netmode	string	No	The network type. The value can only be public (default), which indicates the public network.	public
AutoPay	boolean	No	Specifies whether to enable automatic payment. Valid values: false: disables automatic payment. After an order is generated, go to the Order Center to complete the payment. true: enables automatic payment. The order is automatically paid. This parameter is required if InstanceChargeType is set to PrePaid. This parameter is optional if InstanceChargeType is set to PostPaid.	true
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 if InstanceChargeType is set to PrePaid. This parameter is optional if InstanceChargeType is set to PostPaid.	Month
InstanceChargeType	string	No	The billing method of the EIP to allocate. Valid values: PrePaid: subscription. PostPaid (default): pay-as-you-go. If InstanceChargeType is set to PrePaid, InternetChargeType must be set to PayByBandwidth. If InstanceChargeType is set to PostPaid, InternetChargeType can be set to PayByBandwidth or PayByTraffic.	PostPaid
InternetChargeType	string	No	The metering method of the EIP to allocate. Valid values: PayByBandwidth (default): pay-by-bandwidth. PayByTraffic: pay-by-data-transfer. If InstanceChargeType is set to PrePaid, InternetChargeType must be set to PayByBandwidth. If InstanceChargeType is set to PostPaid, InternetChargeType can be set to PayByBandwidth or PayByTraffic.	PayByBandwidth
ResourceGroupId	string	No	The ID of the resource group to which the EIP belongs.	rg-resourcegroup****
Tag	array<object>	No
	object	No
Key	string	No
Value	string	No
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 be different for each API request.	0c593ea1-3bea-11e9-b96b-88e9fe6****
SecurityProtectionTypes	array	No	The security protection level. If this parameter is left empty, DDoS Protection (Basic) is used by default. If this parameter is set to AntiDDoS_Enhanced, DDoS Protection (Enhanced) is used.
	string	No	The security protection level. If this parameter is left empty, DDoS Protection (Basic) is used by default. If this parameter is set to AntiDDoS_Enhanced, DDoS Protection (Enhanced) is used.
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****

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 is set to false, which means automatic payment is not enabled, go to the Order Center to complete the payment.	20190000
ResourceGroupId	string	The resource group ID. This parameter is returned only when InstanceChargeType is set to PostPaid.	rg-resourcegroup****
EipAddress	string	The IP address assigned to the specified EIP. This parameter is returned only when InstanceChargeType is set to PostPaid.	192.0.XX.XX
AllocationId	string	The ID of the EIP.	eip-25877c70gddh****

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	FrequentPurchase.EIP	eip frequent purchase
400	QuotaExceeded.Eip	Elastic IP address quota exceeded
400	InvalidParameter	Specified value of "InternetChargeType" is not valid
400	ReserveIpFail	Reserve eip failed.
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	Invalid.Reserve.Ip	The reserve ip is invalid.
400	Ip.Allocated	The reserve ip has been allocated.	Reserved IP addresses are already specified.
400	Ip.Keeped	The reserve ip been keeped in an hour.
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	INVALID_INSTANCE_STATUS	The instance status is invalid.
400	OperationFailed.InstanceNotExist	Eip instanceId does not exist.
400	InvalidStatus.ValueNotSupported	The specified status is not supported.
400	OperationFailed.RiskControl	Risk control check failed.	The error message returned because your payment method has security risks. Click the link for verification in your email or console message and submit your order after verification.
400	ResourceNotEnough.PublicIpAddressPool	The specified resource of PublicIpAddressPool is not enough.
400	Mismatch.IpAndPublicIpAddressPool	The Ip and PublicIpAddressPool are mismatched.
400	ResourceNotFound.PublicIpAddressPool	The specified resource of PublicIpAddressPool is not found.
400	ResourceNotFound.Ip	The specified ip is not found.	The specified IP could not be found.
400	OperationDenied.IpBelongToOtherUser	The operation is not allowed because of ip belong to other user.	Your application failed because the IP address belongs to another user.
400	IncorrectStatus.Ip	The status of ip is incorrect.	The status of the IP is incorrect.
400	OperationFailed.IpIsLocked	The operation is failed because of ip is locked.	Your application failed because the IP address is locked.
400	Mismatch.IpAndIsp	The specified IP address does not match the ISP.	The system failed to allocate the specified EIP because the ISP and IP address do not match.
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.IpAddress	The specified IpAddress (%s) is illegal.	The IpAddress parameter is set to an invalid value.
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	Mismatch.EipSecurityProtectionTypeAndPoolSecurityProtectionType	The EipSecurityProtectionType and PoolSecurityProtectionType are mismatched.	The EIP protection type does not match the address pool protection type.
400	IllegalParam.Isp	The param of Isp [%s] is illegal.	The error message returned because the Isp parameter is set to an invalid value. Specify a valid value and try again.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	An internal error occurred.
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.