Contents:
1. API Description
Domain name for API request: vpc.tencentcloudapi.com.
This API (AllocateAddresses) is used to apply for one or more Elastic IPs (EIP).
- EIP is a static IP designed for dynamic cloud computing. With EIP, you can quickly remap the EIP to another instance, shielding off the instance failures.
- Your EIP is associated with a Tencent Cloud account, instead of an instance, until you choose to explicitly release it or your payment is more than seven days overdue.
- The platform imposes quotas on number of EIPs that a user can request for each region. See Overview of EIP products. The above quotas can be obtained via API DescribeAddressQuota.
A maximum of 10 requests can be initiated per second for this API.
Note: This API supports Finance regions. Since Finance regions and non-Finance regions are isolated and not interconnected. If the common parameter Region is a Finance region (such as ap-shanghai-fsi), you need to specify a domain name containing the Finance region that should be identical to the value of Region field, for example: vpc.ap-shanghai-fsi.tencentcloudapi.com.
2. Input Parameters
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 | Number of requested EIPs. Default is 1. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| AddressSet | Array of String | List of unique IDs of the requested EIPs. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Error Codes
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 | Account quota is exceeded. At most 20 EIPs can be created by each Tencent Cloud account in each region. |
| AddressQuotaLimitExceeded.DailyAllocate | The maximum number of requests is exceeded. The maximum number of requests can be made by each Tencent Cloud account in each region equals to two times the quota. |
5. Example
Example 1 Create an EIP
Input example
https://vpc.tencentcloudapi.com/?Action=AllocateAddresses
&AddressCount=1
&<Common request parameters>Output example
{
"Response": {
"AddressSet": [
"eip-m44ku5d2"
],
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
}
}6. Other Resources
Cloud API 3.0 comes with the following development tools to make it easier to call the API.