Domain name for API request: vpc.tencentcloudapi.com.
This API is used to apply for private IPs for an ENI.
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.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.
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. |
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. |
https://vpc.tencentcloudapi.com/?Action=AssignPrivateIpAddresses
&NetworkInterfaceId=eni-afo43z61
&SecondaryPrivateIpAddressCount=2
&<Common request parameters>
{
"Response": {
"PrivateIpAddressSet": [
{
"PrivateIpAddress": "172.16.32.237"
},
{
"PrivateIpAddress": "172.16.32.84"
}
],
"RequestId": "f23d1450-ed00-4442-98d4-be409e625e6c"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
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. |
ResourceInUse | The resource is occupied. |
ResourceInsufficient | Insufficient resources. |
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. |
Was this page helpful?