1. Interface Description
Interface request domain name: vpc.api3.convergecloud.com.
This API (DisassociateAddress) is used to unbind EIPs.
- Supports unbinding of EIPs on CVM instances and ENI.
- Unbinding of EIPs on NAT is not supported. For unbinding EIPs on NAT, refer to [DisassociateNatGatewayAddress](../NAT Gateway APIs/DisassociateNatGatewayAddress).
- Only EIPs in the BIND and BIND_ENI states can be unbound.
- If an EIP is blocked, it cannot be unbound.
Default interface request rate limit: 10 times per second.
Interface update time: 2022-06-24 01:44:02.
The interface only verifies the signature but does not authenticate.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: DisassociateAddress |
| Version | Yes | No | String | Public parameter, The value of this interface: 2017-03-12 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| AddressId | Yes | No | String | The unique ID identifying the EIP, such as eip-jrkzpvgt.Example: eip-ek0cdz1g |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| TaskId | String | Asynchronous task TaskId. The task status can be queried using the DescribeTaskResult API. Example: 61531411 |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidInstanceId.NotFound | Invalid instance ID. The specified instance ID does not exist. |
| InvalidParameter | Invalid input parameters. |
| InvalidAddressId.Blocked | The designated EIP is in a blocked state. Binding operation cannot be performed while the EIP is blocked. Unbinding is required first. |
| InvalidAddressId.NotFound | The specified EIP does not exist. |
| InvalidAddressIdStatus.NotPermit | The current status of the designated EIP does not allow for binding operation. Binding operation can only be performed when the EIP's status is UNBIND. |
| InvalidInstance.NotSupported | The instance is not supported. |