产品动态
产品公告
Domain name for API request: vpc.intl.tencentcloudapi.com.
This API is used to apply for private IPs for an ENI.
Note：
This API is async. You can call the
DescribeVpcTaskResultAPI 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.
| 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 | Yes | String | Common Params. 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. |
| QosLevel | No | String | IP service level. It is used together with SecondaryPrivateIpAddressCount. Values: PT(Gold),AU(Silver),AG `(Bronze) and DEFAULT (Default). |
| ClientToken | No | String | Idempotency token used to ensure request idempotency. This string is generated by the client and must be unique across different requests, with a maximum length of 64 ASCII characters. If this parameter is not specified, request idempotency cannot be guaranteed. |
| Parameter Name | Type | Description |
|---|---|---|
| PrivateIpAddressSet | Array of PrivateIpAddressSpecification | The detailed information of the Private IP. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to apply for an ENI.
POST / HTTP/1.1
Host: vpc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AssignPrivateIpAddresses
<Common request parameters>
{
"NetworkInterfaceId": "eni-afo43z61",
"SecondaryPrivateIpAddressCount": "2"
}
{
"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 |
|---|---|
| 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.IdempotentParameterMismatch | The specified customer token has been used. |
| UnsupportedOperation.IdempotentProcessing | The previous idempotent request is still being processed. Please try again later. |
| 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. |
文档反馈