Note:
This is a legacy API which has been hidden and will no longer be updated. We recommend using the new VPC API 3.0 which is standardized and faster.
This API (UnassignPrivateIpAddresses) is used to return the private IP of ENI.
Domain for API request: vpc.api.qcloud.com
If an auxiliary private IP on the ENI is returned, the API will automatically dissociate it from the elastic public IP. The primary auxiliary private IP on the ENI cannot be returned.
The following request parameter list only provides API request parameters. Common request parameters need to be added when the API is called. For more information, refer to Common Request Parameters. The Action field for this API is UnassignPrivateIpAddresses.
Parameter Name | Required | Type | Description |
---|---|---|---|
vpcId | Yes | String | Virtual private cloud ID of ENI, for example: vpc-7t9nf3pu |
networkInterfaceId | Yes | String | ENI ID, for example: eni-m6dyj72l |
privateIpAddress.n | Yes | Array | The auxiliary private IP address array to be returned, for example: privateIpAddress.0=10.0.0.2 |
Parameter Name | Type | Description |
---|---|---|
code | Int | Error code. 0: Succeeded, other values: Failed |
message | String | Error message |
taskId | Int | Task ID. The operation result can be queried with taskId. |
The following list only provides the business logic error codes for this API. For additional common error codes, refer to VPC Error Codes.
Error Code | Description |
---|---|
InvalidVpc.NotFound | VPC does not exist. Please check the information you entered. You can query the VPC via the DescribeVpcEx API |
InvalidNetworkInterface.NotFound | ENI does not exist. Please check the information you entered. You can query the ENI via the DescribeNetworkInterfaces API |
InvalidPrivateip.IsPrimary | The primary IP cannot be unbound |
Input
https://vpc.api.qcloud.com/v2/index.php?Action=UnassignPrivateIpAddresses &> &vpcId=vpc-7t9nf3pu &networkInterfaceId=eni-m6dyj72l &privateIpAddress.0=10.0.0.2
Output
{
"code": 0,
"message": "",
"codeDesc": "Success",
"data":
{
"taskId": 16284
}
}
Was this page helpful?