DisassociateAddress

Last updated: 2018-10-12 16:15:43

PDF

1. API Description

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

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

  • You can only unbind EIPs with a status of BIND or BIND_ENI.
  • Blocked EIPs cannot be unbound.

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: 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 an EIP. Example of the unique ID of an EIP: eip-11112222.
ReallocateNormalPublicIp No Boolean Indicates whether to allocate a public IP after unbinding an EIP. Supported values:
  • TRUE: Allocate a public IP after unbinding an EIP.
  • FALSE: Do not allocate a public IP after unbinding an EIP.
    Default: 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 for at most 10 times to an account per day. You can acquire more information using the API DescribeAddressQuota.
  • 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.Blocked The specified EIP is blocked. You cannot bind the EIP until it is unblocked.
    InvalidAddressId.NotFound The specified EIP does not exist.
    InvalidAddressIdStatus.NotPermit The specified EIP in the current status cannot be bound. Only EIPs in the UNBIND status can be bound.
    InvalidInstance.NotSupported Unsupported instance.
    InvalidInstanceId.NotFound Invalid instance ID. The specified instance ID does not exist.
    InvalidParameter Invalid input parameter.

    5. Example

    Example 1 Unbind an EIP

    Input example

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

    Output example

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

    6. Other Resources

    Cloud API 3.0 comes with the following development tools to make it easier to call the API.