AssignPrivateIpAddresses

Last updated: 2018-10-12 16:15:55

PDF

1. API Description

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

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

  • An ENI can be bound with a limited number of IPs. For more information about resource limits, please 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 in the same subnet as the ENI, and cannot be in use.
  • You can apply for more than one secondary private IPs for the ENI. The API will return the specified number of secondary private IPs in the subnet IP address range of the ENI.

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

Note: This API supports Finance regions. Since Finance regions and non-Finance regions are isolated and not interconnected. If the common parameter Region is a Finance region (such as ap-shanghai-fsi), you need to specify a domain name containing the Finance region that should be identical to the value of Region field, for example: vpc.ap-shanghai-fsi.tencentcloudapi.com.

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 ENI instance ID, such as eni-m6dyj72l.
PrivateIpAddresses.N No Array of PrivateIpAddressSpecification Specifies the private IP information.
SecondaryPrivateIpAddressCount No Integer Number of new private IPs.

3. Output Parameters

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

4. Error Codes

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.Malformed Invalid input parameter format.
ResourceInsufficient Insufficient resources.
ResourceNotFound Resource does not exist.

5. Example

Example 1 Apply for private IPs for ENI

Input example

https://vpc.tencentcloudapi.com/?Action=AssignPrivateIpAddresses
&Version=2017-03-12
&NetworkInterfaceId=eni-afo43z61
&SecondaryPrivateIpAddressCount=2
&<Common request parameters>

Output example

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

6. Other Resources

Cloud API 3.0 comes with the following development tools to make it easier to call the API.