1. Interface Description
Interface request domain name: vpc.api3.convergecloud.com.
This API (AssignPrivateIpAddresses) is used for ENI to apply for a private IP.
- There is a limit to the number of IP addresses an ENI can be bound to. For more information on resource restrictions, see ENI Usage Limits.
- It is acceptable to specify a private IP address to apply for. The private IP address type cannot be the primary IP. The primary IP already exists and cannot be modified, and the private IP must be within the ENI's subnet and must not be occupied.
- When one or more auxiliary private IPs are applied for on an ENI, the API will return a specified number of auxiliary private IPs within the subnet IP range of the ENI.
Default interface request rate limit: 100 times per second.
Interface update time: 2020-04-01 04:53:40.
The interface only verifies the signature but does not authenticate.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: AssignPrivateIpAddresses |
| Version | Yes | No | String | Public parameter, The value of this interface: 2017-03-12 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| NetworkInterfaceId | Yes | No | String | ENI instance ID, e.g., eni-m6dyj72l. Example: eni-afo43z61 |
| PrivateIpAddresses | No | No | Array of PrivateIpAddressSpecification | Specified VPC IP information, up to 10 can be specified at once. At least one of this and SecondaryPrivateIpAddressCount should be provided. Example:View |
| SecondaryPrivateIpAddressCount | No | No | Uint64 | Number of newly applied private IP addresses. At least one of PrivateIpAddresses and it must be provided. The total number of private IP addresses must not exceed the quota. For details, see <a href="/document/product/576/18527">ENI Usage Limits. Example: 2 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| PrivateIpAddressSet | Array of PrivateIpAddressSpecification | Private IP details. Example:View |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidParameterValue.Malformed | Invalid input format. |
| ResourceNotFound | The resource does not exist |
| ResourceInsufficient | Insufficient resources |