UnassignPrivateIpAddresses

Last updated: 2023-08-23 14:11:31

1. API Description

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

This API is used to return the private IP addresses of an ENI.

If a secondary private IP of an ENI is returned, the EIP will be automatically unassociated as well. The primary private IP of the ENI cannot be returned.

This API is completed asynchronously. If you need to query the execution result of an async task, please use the RequestId returned by this API to poll the DescribeVpcTaskResult API.

A maximum of 100 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: UnassignPrivateIpAddresses.
Version	Yes	String	Common Params. The value used for this API: 2017-03-12.
Region	No	String	Common Params. This parameter is not required for this API.
NetworkInterfaceId	Yes	String	The ID of the ENI instance, such as `eni-m6dyj72l`.
PrivateIpAddresses.N	Yes	Array of PrivateIpAddressSpecification	The information of the specified private IPs. You can specify a maximum of 10 each time.
InstanceId	No	String	Instance ID of the server bound with this IP. This parameter is only applicable when you need to return an IP and unbind the related servers.

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. Example

Example1 Returning private IPs of an ENI

This example shows you how to return the private IPs of an ENI.

Input Example

POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UnassignPrivateIpAddresses
<Common request parameters>

{
    "NetworkInterfaceId": "eni-afo43z61",
    "PrivateIpAddresses": [
        {
            "PrivateIpAddress": "172.16.32.111"
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "f23d1450-ed00-4442-98d4-be409e625e6c"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

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
InvalidParameterValue.DuplicatePara	The parameter value already exists.
InvalidParameterValue.LimitExceeded	The parameter value exceeds the limit.
InvalidParameterValue.Malformed	Invalid input parameter format.
LimitExceeded.ActionLimited	Too often API invocations
ResourceNotFound	The resource does not exist.
UnsupportedOperation	Unsupported operation.
UnsupportedOperation.AttachmentNotFound	The binding relationship does not exist.
UnsupportedOperation.InvalidState	Invalid resource status.
UnsupportedOperation.MutexOperationTaskRunning	The resource mutual exclusion operation is being executed.

tencent cloud

Recent Pages