tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ReleaseAddresses

Last updated: 2023-08-23 14:11:33

1. API Description

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

This API (ReleaseAddresses) is used to release one or multiple Elastic IPs.

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

A maximum of 10 requests can be initiated per second for this API.

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 Params. The value used for this API: ReleaseAddresses.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
AddressIds.N Yes Array of String The unique ID list of the EIP. The unique ID of an EIP is as follows: eip-11112222.

3. Output Parameters

Parameter Name Type Description
TaskId String The async task ID. You can use the DescribeTaskResult API to query the task status.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Releasing an EIP

Input Example

POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ReleaseAddresses
<Common request parameters>

{
    "AddressIds": [
        "eip-gzc5rgr2"
    ]
}

Output Example

{
    "Response": {
        "TaskId": "12331420",
        "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

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
FailedOperation.TaskFailed Task execution failed.
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.
InvalidAddressId.NotFound The specified EIP does not exist.
InvalidAddressState The operation cannot be performed on the specified EIP in current status.
InvalidParameterValue.AddressIdMalformed This IP address ID is invalid.
InvalidParameterValue.AddressInternetChargeTypeConflict The billing mode of this IP address conflicts with that of other IP addresses.
InvalidParameterValue.AddressNotFound Unable to find the address.
InvalidParameterValue.AddressTypeConflict Invalid IP address type
LimitExceeded.AccountReturnQuota Ran out of the quota for returning under this account.
OperationDenied.MutexTaskRunning Mutually exclusive tasks are executing.
UnsupportedOperation.AddressStatusNotPermit This operation is not supported by the IP address status.
UnsupportedOperation.UnpaidOrderAlreadyExists Overdue payments are found under this account. Please complete the payment first.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy