tencent cloud

文档反馈

DisassociateAddress

最后更新时间:2023-08-18 14:28:15

1. API Description

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

This API is used to unbind an EIP.
Only EIPs in BIND or BIND_ENI status can be unbound.
Blocked EIPs cannot be unbound.

A maximum of 20 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: DisassociateAddress.
Version Yes String Common Params. The value used for this API: 2019-07-19.
Region No String Common Params. This parameter is not required for this API.
EcmRegion Yes String ECM region
AddressId Yes String Unique EIP ID, such as eip-11112222.
ReallocateNormalPublicIp No Boolean Indicates whether to assign a general public IP after unbinding an EIP. Valid values:
TRUE: yes
FALSE: no.
Default value: FALSE.

You can specify this parameter only under the following conditions:
You can specify this parameter only when you unbind an EIP from the primary private IP of the primary ENI.
An account can reassign a general public IP after unbinding an EIP 10 times a day. More information can be obtained through the DescribeAddressQuota API.

3. Output Parameters

Parameter Name Type Description
TaskId String Async task ID (TaskId). 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 Unbinding EIP

Input Example

https://ecm.tencentcloudapi.com/?Action=DisassociateAddress
&AddressId=eip-11112222
&EcmRegion=ap-hangzhou-ecm
&<Common request parameters>

Output Example

{
    "Response": {
        "TaskId": "123",
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
    }
}

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.InternalOperationFailure Internal error.
FailedOperation.OperationNotAllow The current operation is not allowed.
InvalidParameter The parameter is incorrect.
InvalidParameter.InvalidDataFormat The data format is incorrect.
InvalidParameterValue The parameter value is incorrect.
InvalidParameterValue.InvaildAddressId The EIP is invalid.
InvalidParameterValue.InvalidPublicParam The common parameter is invalid.
InvalidParameterValue.InvalidRegion The ECM region is invalid.
MissingParameter The parameter is missing.
ResourceInUse The resource is in use.
ResourceNotFound The resource does not exist.
UnauthorizedOperation.ForbiddenOperation You don't have the permission to perform this operation.
UnsupportedOperation.AddressIdNotFound The IP was not found.
UnsupportedOperation.InstanceIdNotFound The instance ID is invalid, as the specified instance ID does not exist.
UnsupportedOperation.InstanceIdNotSupported The instance is not supported.
UnsupportedOperation.QuotaLimitExceeded The instance specification supports binding only three EIPs.
UnsupportedOperation.StatusNotPermit This operation cannot be performed in the current status.