TransformAddress

Download PDF

Last updated: 2021-09-30 18:07:52

Download PDF

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

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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 Converting a public IP to an EIP

Input Example

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

Output Example

{
"Response": {
  "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
}
}

5. Developer Resources

SDK

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

Command Line Interface

Tencent Cloud CLI 3.0

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.
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.
InvalidInstance.NotSupported	This instance is not supported.
InvalidInstanceId.AlreadyBindEip	The specified instance has already been bound to an EIP. You must unbind the current EIP first before binding another EIP.
InvalidInstanceId.NotFound	Invalid instance ID. The specified instance ID does not exist.
InvalidParameterValue.InstanceNoWanIP
InvalidParameterValue.InvalidInstanceState

Recent Pages