DisassociateAddress

Last updated: 2020-03-06 20:27:24

1. API Description

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

This API (DisassociateAddress) is used to unbind Elastic IPs.

  • The unbinding of EIPs from CVM instances and ENIs is supported.
  • The unbinding of EIPs from NATs is not supported. For information about how to unbind an EIP from a NAT, see EipUnBindNatGateway.
  • You can only unbind EIPs in BIND or BIND_ENI status.
  • Blocked EIPs cannot be unbound.

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

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: DisassociateAddress.
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.
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://cloud.tencent.com/document/api/213/1378) 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

    https://vpc.tencentcloudapi.com/?Action=DisassociateAddress
    &AddressId=eip-ek0cdz1g
    &<Common request parameters>

    Output Example

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

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    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
    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 Invalid input parameter.