tencent cloud



Last updated: 2022-09-09 10:23:20

    1. API Description

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

    This API is used to unbind an Elastic IP (EIP for short).

    • This API supports unbinding an EIP from CVM instances and ENIs.
    • This API does not support unbinding an EIP from a NAT Gateway. To unbind an EIP from a NAT Gateway, use the DisassociateNatGatewayAddress API.
    • Only EIPs in BIND or BIND_ENI status can be unbound.
    • Blocked EIPs cannot be unbound.

    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: DisassociateAddress.
    Version Yes String Common Params. The value used for this API: 2017-03-12.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    AddressId Yes String The unique ID of the EIP, such as eip-11112222.
    ReallocateNormalPublicIp No Boolean Whether a common public IP is assigned after the EIP is unbound. Value range:
  • TRUE: Indicates that after the EIP is unbound, a common public IP is assigned.
  • FALSE: Indicates that after the EIP is unbound, a common public IP is not assigned.
    Default value: FALSE.

    The parameter can be specified only under the following conditions:
  • It can only be specified when you unbind an EIP from the primary private IP of the primary ENI.
  • After an EIP is unbound, you can assign public IPs to an account up to 10 times per day. For more information, use the [DescribeAddressQuota] (https://www.tencentcloud.com/document/api/213/1378?from_cn_redirect=1) API.
  • 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 Unbinding an EIP

    Input Example

    POST / HTTP/1.1
    Host: vpc.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DisassociateAddress
    <Common request parameters>
      "AddressId": "eip-ek0cdz1g"

    Output Example

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

    5. Developer Resources


    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.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.
    FailedOperation.AddressEniInfoNotFound The ENI information is not available in this address.
    FailedOperation.MasterEniNotFound The instance's primary ENI is not found.
    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.
    InvalidAddressIdStatus.NotPermit The specified EIP cannot be bound in current status. It can only be bound in UNBIND status.
    InvalidInstance.NotSupported This instance is not supported.
    InvalidInstanceId.NotFound Invalid instance ID. The specified instance ID does not exist.
    InvalidParameter A parameter error occurred.
    InvalidParameterValue.AddressIdMalformed This IP address ID is invalid.
    InvalidParameterValue.AddressNotFound Unable to find the address.
    InvalidParameterValue.InstanceIdMalformed Incorrect instance ID.
    InvalidParameterValue.OnlySupportedForMasterNetworkCard This operation is only available for primary ENIs.
    InvalidParameterValue.ResourceNotSupport The resource does not support this operation.
    OperationDenied.MutexTaskRunning Mutually exclusive tasks are executing.
    UnsupportedOperation.ActionNotFound The port does not exist.
    UnsupportedOperation.AddressStatusNotPermit This operation is not supported by the IP address status.
    UnsupportedOperation.InvalidAction Unsupported operation.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support