Tencent Cloud

search by keyword

Recent Pages

Documentation

AssignPrivateIpAddresses

Last updated: 2020-06-24 12:20:09

1. API Description

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

This API (AssignPrivateIpAddresses) is used for the ENI to apply for private IPs.

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 specify the private IP you want to apply for. It cannot be the primary IP, which already exists and cannot be modified. The private IP must be in the same subnet as the ENI, and cannot be occupied.
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 of the ENI.

A maximum of 100 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: vpc.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: AssignPrivateIpAddresses.
Version	Yes	String	Common parameter. The value used for this API: 2017-03-12.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
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.

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 Applies for private IPs for an ENI

Input Example

https://vpc.tencentcloudapi.com/?Action=AssignPrivateIpAddresses
&NetworkInterfaceId=eni-afo43z61
&SecondaryPrivateIpAddressCount=2
&<Common request parameter>

Output Example

{
  "Response": {
    "PrivateIpAddressSet": [
      {
        "PrivateIpAddress": "172.16.32.237"
      },
      {
        "PrivateIpAddress": "172.16.32.84"
      }
    ],
    "RequestId": "f23d1450-ed00-4442-98d4-be409e625e6c"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.