TransformAddress

Last updated: 2018-10-12 16:15:40

PDF

1. API Description

Domain name for API request: vpc.tencentcloudapi.com.

This API (TransformAddress) is used to convert an ordinary public IP into an Elastic IP (EIP).

  • The platform imposes a quota on the number of attempts to unbind an EIP and reallocate an ordinary public IP per day for each region (See Overview of EIP products). The above quota can be obtained through 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: TransformAddress
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.
InstanceId Yes String ID of the instance with a public IP you are working with, such as ins-11112222. It can be queried through the console or obtained from the InstanceId field value in the returned result of API DescribeInstances.

3. Output Parameters

Parameter Name Type Description
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.
InvalidInstance.NotSupported Unsupported instance.
InvalidInstanceId.NotFound Invalid instance ID. The specified instance ID does not exist.

5. Example

Example 1 Convert an ordinary IP to an EIP

Input example

https://eip.tencentcloudapi.com/?Action=TransformAddress
&InstanceId=ins-3ea0qeu6
&<Common request parameters>

Output example

{
  "Response": {
    "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.