Help & DocumentationVirtual Private CloudAPI DocumentationEIP-Related APIsTransformAddress

TransformAddress

Last updated: 2020-03-30 16:13:30

PDF

Contents：

1. API Description

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

This API (TransformAddress) is used to switch common public IPs into Elastic IPs.

  • The platform limits the number of times that a user can unbind an EIP and reassign public IPs in each region per day. For more information, see EIP product introduction). The preceding quota can be obtained through the DescribeAddressQuota API.

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

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 The ID of the instance with a common public IP to be operated on, such as ins-11112222. You can query the instance ID by logging into the Console. You can also obtain the parameter value from the InstanceId field in the returned result of DescribeInstances API.

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. Example

Example1 Switching 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"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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.
InvalidInstance.NotSupported This instance is not supported.
InvalidInstanceId.NotFound Invalid instance ID. The specified instance ID does not exist.