tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

AssignPrivateIpAddresses

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

1. API Description

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

This API is used to apply for private IPs for an ENI.

  • An ENI can only be bound with a limited number of IP addresses. For more information about resource limits, see ENI Use Limits.
  • You can apply for a specified private IP. It cannot be a primary IP because the primary IP already exists and cannot be modified. The private IP address must be an idle IP in the subnet to which the ENI belongs.
  • You can apply for more than one secondary private IP on the ENI. The API will return the specified number of secondary private IPs in the subnet IP range.

    Note：

    This API is async. You can call the DescribeVpcTaskResult API to query the task result. When the task is completed, you can continue other tasks.

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: AssignPrivateIpAddresses.
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 No Array of PrivateIpAddressSpecification The information on private IP addresses, of which you can specify a maximum of 10 at a time. You should provide either this parameter or SecondaryPrivateIpAddressCount, or both.
SecondaryPrivateIpAddressCount No Integer The number of newly-applied private IP addresses. You should provide either this parameter or PrivateIpAddresses, or both. The total number of private IP addresses cannot exceed the quota. For more information, seeENI Use Limits.
QosLevel No String IP u200dservice level. It is used together with SecondaryPrivateIpAddressCount. Values: PTu200d(Gold),AUu200d(Silver),AG `(Bronze) and DEFAULT (Default).

3. Output Parameters

Parameter Name Type Description
PrivateIpAddressSet Array of PrivateIpAddressSpecification The detailed information of the Private IP.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Applying for a private IP for an ENI

This example shows you how to apply for an ENI.

Input Example

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

{
    "NetworkInterfaceId": "eni-afo43z61",
    "SecondaryPrivateIpAddressCount": "2"
}

Output Example

{
    "Response": {
        "PrivateIpAddressSet": [
            {
                "PrivateIpAddress": "172.16.32.237"
            },
            {
                "PrivateIpAddress": "172.16.32.84"
            }
        ],
        "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.NetDetectTimeOut Network probe timed out. Please retry later.
InvalidParameterValue.DuplicatePara The parameter value already exists.
InvalidParameterValue.LimitExceeded The parameter value exceeds the limit.
InvalidParameterValue.Malformed Invalid input parameter format.
InvalidParameterValue.Range The parameter value is not in the specified range.
InvalidParameterValue.Reserved The parameter value is retained by the system.
LimitExceeded Quota limit is reached.
LimitExceeded.ActionLimited Too often API invocations
MissingParameter Missing parameter.
ResourceInUse The resource is occupied.
ResourceInsufficient Insufficient resources.
ResourceInsufficient.Subnet The subnet does not have sufficient IPs.
ResourceNotFound The resource does not exist.
UnsupportedOperation Unsupported operation.
UnsupportedOperation.InvalidState Invalid resource status.
UnsupportedOperation.MutexOperationTaskRunning The resource mutual exclusion operation is being executed.
UnsupportedOperation.ResourceMismatch The resource ID entered does not match with any resource bound with the IP. Check and try again.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy