Applies for a specified elastic IP address (EIP).

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes AllocateEipAddressPro

The operation that you want to perform. Set the value to AllocateEipAddressPro.

RegionId String Yes cn-hangzhou

The ID of the region where you want to apply for a specified EIP.

You can call the DescribeRegions operation to query the most recent region list.

IpAddress String No 12.01.XX.XX

The IP address of the EIP to be requested.

Set IpAddress or InstanceId. If you leave both parameters empty, the system randomly allocates an EIP.

InstanceId String No eip-25877c70gddh****

The ID of the EIP to be requested.

Set IpAddress or InstanceId. If you leave both parameters empty, the system randomly allocates an EIP.

Bandwidth String No 5

The maximum bandwidth value of the EIP. Valid values:

  • 1 to 200: uses the pay-by-data-transfer metering method. Unit: Mbit/s.
  • 1 to 500: uses the pay-by-bandwidth metering method. Unit: Mbit/s.

Default value: 5.

Period Integer No 1

The subscription duration of the EIP.

  • When PricingCycle is set to Month, set Period to a value from 1 to 9.
  • When PricingCycle is set to Year, set Period to a value from 1 to 3.

This parameter is required when InstanceChargeType is set to PrePaid.

Ignore this parameter when InstanceChargeType is set to PostPaid.

ISP String No BGP

The line type. Default value: BGP.

  • If your account is in the single-line BGP whitelist, you can set the parameter to ChinaTelecom, ChinaUnicom, or ChinaMobile.
  • This parameter is required if your workloads are deployed in the China East 1 Finance region. In this case, set the value to BGP_FinanceCloud.
Netmode String No public

The network type. Valid value:

public (default): Internet

AutoPay Boolean No true

Specifies whether to enable automatic payment. Valid values:

  • false: disables automatic payment. After an order is generated, you must go to Order Center to complete the payment.
  • true: enables automatic payment. The system automatically pays for the orders.

This parameter is required when InstanceChargeType is set to PrePaid.

Ignore this parameter when InstanceChargeType is set to PostPaid.

PricingCycle String No Month

The billing cycle of the subscription EIP. Valid values:

  • Month (default): The EIP is billed on a monthly basis.
  • Year: The EIP is billed on an annual basis.

This parameter is required when InstanceChargeType is set to PrePaid. This parameter is optional when InstanceChargeType is set to PostPaid.

InstanceChargeType String No PostPaid

The billing method of the specified EIP. Valid values:

  • PrePaid: subscription
  • PostPaid: pay-as-you-go. This is the default value.

When InstanceChargeType is set to PrePaid, you must set InternetChargeType to PayByBandwidth.

When InstanceChargeType is set to PostPaid, set InternetChargeType to PayByBandwidth or PayByTraffic.

InternetChargeType String No PayByBandwidth

The metering method of the specified EIP. Valid values:

  • PayByBandwidth (default): pay-by-bandwidth
  • PayByTraffic: pay-by-data-transfer

When InstanceChargeType is set to PrePaid, you must set InternetChargeType to PayByBandwidth.

When InstanceChargeType is set to PostPaid, set InternetChargeType to PayByBandwidth or PayByTraffic.

ResourceGroupId String No rg-resourcegroup****

The ID of the resource group to which the EIP belongs.

ClientToken String No 0c593ea1-3bea-11e9-b96b-88e9fe6****

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 make sure that it is unique among different requests. Client Token can contain only ASCII characters. It cannot exceed 64 characters in length.

Response parameters

Parameter Type Example Description
AllocationId String eip-25877c70gddh****

The ID of the specified EIP.

EipAddress String 12.01.XX.XX

The IP address of the specified EIP.

OrderId Long 20190000

The ID of the order.

RequestId String 4EC47282-1B74-4534-BD0E-403F3EE64CAF

The ID of the request.

ResourceGroupId String rg-resourcegroup****

The ID of the resource group.

Examples

Sample requests

http(s)://[Endpoint]/?Action=AllocateEipAddressPro
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

<AllocateEipAddressProResponse>
  <ResourceGroupId>rg-resourcegroup****</ResourceGroupId>
  <RequestId>4EC47282-1B74-4534-BD0E-403F3EE64CAF</RequestId>
  <AllocationId>eip-25877c70gddh****</AllocationId>
  <EipAddress>12.01.XX.XX</EipAddress>
  <OrderId>20190000</OrderId>
</AllocateEipAddressProResponse>

JSON format

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

Error codes

HttpCode Error code Error message Description
403 Forbbiden User not authorized to operate on the specified resource. The error message returned because you are unauthorized to perform the operation on the specified resource. Apply for permissions and try again.
400 InvalidParameter Specified value of "Bandwidth" is not valid. The error message returned because the specified bandwidth value is invalid.
400 InsufficientBalance Your account does not have enough balance. The error message returned because the balance in your account is insufficient. Top up your account and try again.
400 QuotaExceeded.Eip Elastic IP address quota exceeded. The error message returned because the number of EIPs has reached the upper limit. To request a quota increase, submit a ticket. We recommend that you use NAT gateways.
400 ReserveIpFail Reserve eip failed. The error message returned because the system failed to reserve the EIP.
400 InvalidRegion.NotSupport The specified region does not support. The error message returned because the specified region does not support this operation.
400 InvalidResourceGroupId The specified ResourceGroupId does not exist. The error message returned because the specified resource group ID does not exist.

For a list of error codes, visit the API Error Center.