tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

RemovePrivateIpAddresses

Last updated: 2023-08-18 14:28:12

1. API Description

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

This API is used to return the private IPs of an ENI.
To return the secondary private IPs of an ENI, the API will automatically unbind them from the ENI. The primary private IP of the ENI cannot be returned.

A maximum of 20 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: RemovePrivateIpAddresses.
Version Yes String Common Params. The value used for this API: 2019-07-19.
Region No String Common Params. This parameter is not required for this API.
EcmRegion Yes String ECM region, such as ap-xian-ecm.
NetworkInterfaceId Yes String ENI instance ID, such as eni-11112222.
PrivateIpAddresses.N Yes Array of PrivateIpAddressSpecification Information of the specified private IPs. You can specify up to 10 IPs at a time.

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 the private IPs of ENI

Input Example

https://ecm.tencentcloudapi.com/?Action=RemovePrivateIpAddresses
&NetworkInterfaceId=eni-12121212
&PrivateIpAddresses.0.PrivateIpAddress=172.16.32.111
&EcmRegion=ap-hangzhou-ecm
&<Common request parameters>

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

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
FailedOperation.InternalOperationFailure Internal error.
InvalidParameter The parameter is incorrect.
InvalidParameter.InvalidDataFormat The data format is incorrect.
InvalidParameterValue.InvalidPublicParam The common parameter is invalid.
InvalidParameterValue.Malformed The input parameter format is invalid.
ResourceNotFound The resource does not exist.
UnauthorizedOperation.ForbiddenOperation You don't have the permission to perform this operation.
UnsupportedOperation Unsupported operation.
UnsupportedOperation.AttachmentNotFound The instance is not associated.
UnsupportedOperation.MutexOperationTaskRunning A task with a mutually exclusive resource is being executed.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy