Domain name for API request: vpc.tencentcloudapi.com.
This API is used to apply for one or more Elastic IP Addresses (EIPs for short).
A maximum of 10 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: vpc.ap-shanghai-fsi.tencentcloudapi.com
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common parameter. The value used for this API: AllocateAddresses. |
Version | Yes | String | Common parameter. The value used for this API: 2017-03-12. |
Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
AddressCount | No | Integer | The number of EIPs. Default: 1. |
InternetServiceProvider | No | String | The EIP line type. Default: BGP.
|
InternetChargeType | No | String | The EIP billing method.
|
InternetMaxBandwidthOut | No | Integer | The EIP outbound bandwidth cap, in Mbps.
|
AddressChargePrepaid | No | AddressChargePrepaid | A required billing parameter for an EIP billed by monthly bandwidth subscription. For EIPs using other billing modes, it can be ignored. |
AddressType | No | String | The EIP type. Default: EIP.
|
AnycastZone | No | String | Anycast publishing region
|
ApplicableForCLB | No | Boolean | [Disused] Whether the Anycast EIP can be bound to CLB instances.
|
Tags.N | No | Array of Tag | List of tags to be bound. |
BandwidthPackageId | No | String | The unique ID of a BGP bandwidth package. If you configure this parameter and set InternetChargeType as BANDWIDTH_PACKAGE, the new EIP is added to this package and billed by the bandwidth package mode. |
Parameter Name | Type | Description |
---|---|---|
AddressSet | Array of String | List of the unique IDs of the requested EIPs. |
TaskId | String | The Async task ID. You can use the DescribeTaskResult API to query the task status. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
You should have activated Anycast Internet Acceleration (AIA) Whitelist service.
https://vpc.tencentcloudapi.com/?Action=AllocateAddresses
&AddressCount=1
&AddressType=AnycastEIP
&<Common request parameters>
{
"Response": {
"AddressSet": [
"eip-m44ku5d2"
],
"TaskId": "61531428",
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
}
}
https://vpc.tencentcloudapi.com/?Action=AllocateAddresses
&AddressCount=1
&<Common request parameter>
{
"Response": {
"AddressSet": [
"eip-m44ku5d2"
],
"TaskId": "61531421",
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
}
}
You should have activated the service of static single-line IP whitelist.
https://vpc.tencentcloudapi.com/?Action=AllocateAddresses
&AddressCount=1
&InternetServiceProvider=CTCC
&<Common request parameter>
{
"Response": {
"AddressSet": [
"eip-m44ku5d2"
],
"TaskId": "61531429",
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
AddressQuotaLimitExceeded | The account quota is reached. Each Tencent Cloud account can create up to 20 EIPs in each region. |
AddressQuotaLimitExceeded.DailyAllocate | The maximum number of requests is reached. The maximum number of requests made by a Tencent Cloud account per day in each region equals to two times the quota. |
InvalidAddressId.Blocked | The specified EIP is in blocked status. When the EIP is in blocked status, it cannot be bound. You must first unblock it. |
InvalidParameterConflict | The two parameters cannot be specified at the same time, nor exist concurrently. EIP can only be bound to the instances or the specified private IPs of the specified ENIs. |
InvalidParameterValue.BandwidthOutOfRange | The bandwidth exceeds the limit. |
InvalidParameterValue.BandwidthTooSmall | The selected bandwidth is smaller than the minimum permissible range. |
InvalidParameterValue.InvalidDedicatedClusterId | |
ResourceInsufficient | Insufficient resources. |
Was this page helpful?