Applies for a specified elastic IP address (EIP) to meet specific network configuration requirements.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
vpc:AllocateEipAddressPro |
create |
*Address
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
The region ID of the specified EIP. You can call the DescribeRegions operation to query region IDs. |
cn-hangzhou |
| IpAddress |
string |
No |
The IP address of the specified EIP. 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 specified EIP. 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 specified EIP. Unit: Mbit/s.
Default value: 5. |
5 |
| Period |
integer |
No |
The subscription duration.
This parameter is required if InstanceChargeType is set to PrePaid. Do not specify this parameter if InstanceChargeType is set to PostPaid. |
1 |
| ISP |
string |
No |
The line type. Valid values:
For more information about BGP (multi-ISP) and BGP (multi-ISP) Pro lines, see EIP line types.
|
BGP |
| Netmode |
string |
No |
The network type. Set the value to public (default), which indicates the Internet. |
public |
| AutoPay |
boolean |
No |
Specifies whether to enable automatic payment. Valid values:
This parameter is required if InstanceChargeType is set to PrePaid. You can leave this parameter empty if InstanceChargeType is set to PostPaid. |
true |
| PricingCycle |
string |
No |
The billing cycle of the subscription. Valid values:
This parameter is required if InstanceChargeType is set to PrePaid. You can leave this parameter empty if InstanceChargeType is set to PostPaid. |
Month |
| InstanceChargeType |
string |
No |
The billing method of the specified EIP. Valid values:
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 specified EIP. Valid values:
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 specified 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. You can use the client to generate the value, but you must ensure that it is unique among 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 unique. |
0c593ea1-3bea-11e9-b96b-88e9fe6**** |
| SecurityProtectionTypes |
array |
No |
The security protection level.
|
|
|
string |
No |
The security protection level.
|
||
| PublicIpAddressPoolId |
string |
No |
The ID of the IP address pool. The EIP is allocated from this IP address pool. By default, the IP address pool feature is not available. To use this feature, apply for the quota of the IP address pool feature privilege quota Center. For more information, see Increase quotas privilege quota Center. |
pippool-2vc0kxcedhquybdsz**** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The returned information. |
||
| RequestId |
string |
The request ID. |
4EC47282-1B74-4534-BD0E-403F3EE64CAF |
| OrderId |
integer |
The order ID. This parameter is returned if InstanceChargeType (the billing method of the specified EIP) is set to PrePaid (subscription). If AutoPay is set to false, which means automatic payment is disabled, go to the User Center to complete the payment. |
20190000 |
| ResourceGroupId |
string |
The resource group ID. This parameter is returned only if InstanceChargeType is set to PostPaid. |
rg-resourcegroup**** |
| EipAddress |
string |
The IP address allocated to the specified EIP. This parameter is returned only if 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. | |
| 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.