Help & DocumentationAPIsVirtual Private CloudEIP-Related APIsReleaseAddresses

ReleaseAddresses

Last updated: 2019-11-29 17:48:44

Contents：

1. API Description

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

This API (ReleaseAddresses) is used to release one or more Elastic IP(EIP).

  • This operation is irreversible. Once you release an EIP, the IP address associated with the EIP no longer belongs to you.
  • Only EIPs in the UNBIND status can be released.

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: ReleaseAddresses
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.
AddressIds.N No Array of String List of unique IDs of EIPs. Example of the unique ID of an EIP: eip-11112222.

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
InvalidAddressId.NotFound The specified EIP does not exist.
InvalidAddressState The operation is not allowed for the specified EIP due to its status.

5. Example

Example 1 Release an EIP

Input example

https://vpc.tencentcloudapi.com/?Action=ReleaseAddresses
&AddressIds.0=eip-gzc5rgr2
&<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.