All Products
Search
Document Center

Elastic Compute Service:AssignPrivateIpAddresses

Last Updated:Mar 19, 2024

Assigns one or more secondary private IP addresses to an elastic network interface (ENI). You can specify available private IP addresses within the CIDR block of the vSwitch that hosts the ENI. Alternatively, you can specify the number of private IP addresses for Elastic Compute Service (ECS) to automatically assign them.

Operation description

Usage notes

  • The ENI to which you want to assign secondary private IP addresses must be in the Available (Available) or InUse (InUse) state.
  • When you assign secondary private IP addresses to a primary ENI, the instance to which the ENI is attached must be in the Running (Running) or Stopped (Stopped) state.
  • When an ENI is in the Available state, you can assign up to 50 secondary private IP addresses to it. When an ENI is attached to an instance, the number of secondary private IP addresses that can be assigned to the ENI is subject to the instance type. For more information, see Overview of instance families.
  • After you call this operation for an ENI, you can obtain the secondary private IP addresses that are assigned to the ENI from the response.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the ENI. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
NetworkInterfaceIdstringYes

The ID of the ENI.

eni-bp67acfmxazb4p****
SecondaryPrivateIpAddressCountintegerNo

The number of private IP addresses to be automatically assigned from the CIDR block of the vSwitch that is connected to the ENI.

To assign secondary private IP addresses to the ENI, you must specify PrivateIpAddress.N or SecondaryPrivateIpAddressCount but not both.

1
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

123e4567-e89b-12d3-a456-426655440000
PrivateIpAddressarrayNo

Secondary private IP address N to be automatically assigned from the CIDR block of the vSwitch that is connected to the ENI. Valid values of N:

  • When the ENI is in the Available (Available) state, the valid values of N are 1 to 50.
  • When the ENI is in the InUse (InUse) state, the valid values of N are subject to the instance type. For more information, see Overview of instance families.

To assign secondary private IP addresses to the ENI, you must specify PrivateIpAddress.N or SecondaryPrivateIpAddressCount but not both.

stringNo

Secondary private IP address N to be automatically assigned from the CIDR block of the vSwitch that is connected to the ENI. Valid values of N:

  • When the ENI is in the Available (Available) state, the valid values of N are 1 to 50.
  • When the ENI is in the InUse (InUse) state, the valid values of N are subject to the instance type. For more information, see Overview of instance families.
Note To assign secondary private IP addresses to the ENI, you specify PrivateIpAddress.N and SecondaryPrivateIpAddressCount but not both.
10.1.**.**

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
AssignedPrivateIpAddressesSetobject

Details about the ENI and the secondary private IP addresses that are assigned to the ENI.

NetworkInterfaceIdstring

The ENI ID.

eni-bp125p95hhdhn3ot****
PrivateIpSetarray

The secondary private IP addresses that are assigned to the ENI.

string

The secondary private IP address that is assigned to the ENI.

192.168.**.**

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "AssignedPrivateIpAddressesSet": {
    "NetworkInterfaceId": "eni-bp125p95hhdhn3ot****",
    "PrivateIpSet": {
      "PrivateIpAddress": [
        "192.168.**.**"
      ]
    },
    "Ipv4PrefixSet": {
      "Ipv4Prefixes": [
        "hide"
      ]
    }
  }
}

Error codes

HTTP status codeError codeError messageDescription
400ThrottlingRequest was denied due to request throttling.-
400InvalidOperation.Unsupported%s-
400UnsupportedParameter%sThe parameter is not supported.
400InvalidParameter%sThe specified parameter is invalid.
400InvalidInstanceID.Malformed%sThe specified InstanceId parameter is invalid.
400InvalidOperation.InvalidEcsState%s-
400InvalidOperation.InvalidEniState%s-
400InvalidOperation.DetachPrimaryEniNotAllowed%s-
400MissingParameter%sA parameter is not specified.
400Forbidden.RegionId%sThe service is unavailable in the current region.
400InvalidAction%sThe operation is invalid.
400InvalidEniId.MalformedThe specified parameter "EniId" is not valid.-
400IncorrectVSwitchStatusThe current status of vSwitch does not support this operation.-
400InvalidPrivateIpAddress.DuplicatedSpecified private IP address is duplicated.The specified private IP address is already in use. Try a different IP address.
400InvalidPrivateIpAddress.Malformed%s-
400InvalidSecondaryPrivateIpAddressCount.Malformed%s-
400QuotaExceeded.PrivateIpAddressThere is no enough private ip in the specified VSwitch.-
400InvalidOperation.InvalidEniStateThe operation is not allowed in the current ENI state.-
400InvalidParameter.Conflict%sThe specified parameter is invalid. Check whether parameter conflicts exist. %s is a variable. An error message is dynamically returned based on call conditions.
403InvalidUserType.NotSupported%sYour account does not support this operation.
403Abs.InvalidAccount.NotFound%sYour Alibaba Cloud account does not exist or your AccessKey pair has expired.
403Forbidden.NotSupportRAM%sRAM users are not authorized to perform this operation.
403Forbidden.SubUser%sYou are not authorized to manage this resource. Contact the owner of the Alibaba Cloud account for authorization.
403MaxEniCountExceeded%sThe maximum number of ENIs that can be managed has been reached.
403EniPerInstanceLimitExceeded%sThe maximum number of ENIs that can be attached to the specified instance has been reached.
403InvalidOperation.AvailabilityZoneMismatch%sThe operation is invalid.
403InvalidOperation.VpcMismatch%sThe operation is invalid. Check whether the VPC in the operation corresponds to other parameters.
403SecurityGroupInstanceLimitExceed%s-
403InvalidSecurityGroupId.NotVpc%sThe specified SecurityGroupId parameter is invalid and the network type of the security group is not VPC.
403InvalidOperation.InvalidEniType%s-
403InvalidVSwitchId.IpNotEnough%sThe number of available IP addresses on the specified vSwitch is insufficient.
403InvalidVSwitchId.IpInvalid%sThe specified private IP address is invalid.
403InvalidIp.IpAssigned%sThe specified IP address is already assigned.
403MaxEniPrivateIpsCountExceeded%sThe maximum number of secondary private IP addresses that can be assigned to the specified ENI has been exceeded. For more information, see the return value of the %s placeholder in the error message.
403Operation.Conflict%sThis operation conflicts with another operation in progress. Try again later.
403InvalidOperation.Ipv4CountExceeded%sThe operation is valid because the maximum number of IPv4 addresses has been reached.
403InvalidOperation.EniServiceManaged%sThe operation is invalid.
403InvalidIp.IpRepeated%sThe specified IP address already exists.
403InvalidIp.IpPrefixIllegalThe ip prefixes %s is/are illegal.The IP address prefix is invalid and is not in the CIDR format.
403InvalidIp.IpPrefixMaskIllegalThe ip prefix mask is illegal.The IP address prefix mask is invalid.
403InvalidIp.IpPrefixMaskInvalidThe ip prefixes mask %s is illegal which must be between %s and %s.The IP address prefix mask is invalid and is not within the valid range.
403InvalidIp.IpPrefixMaskNotSameThe ip prefixes %s are illegal which mask must be same.The IP address prefix masks are not the same.
403InvalidIp.IpPrefixMustInReserveSegmentThe ip prefix must in vswitch reserve segment.The IP address prefix is invalid and is not in the reserved CIDR block of the vSwitch.
403InvalidIp.IpPrefixNotAvailableThe ip prefix is/are not available.The IP address prefix is not available.
403InvalidIp.IpPrefixNotStrictThe ip prefix must be strict cidr format.The IP address prefix is invalid and is not in the CIDR format.
403InvalidVSwitchId.IpPrefixNotEnoughThe specified vSwitch has not enough ip prefix.The number of IP address prefixes in the specified vSwitch is insufficient.
403MissingParameterThese parameters %s cannot be both empty.A required parameter is not specified. The required parameters cannot be empty.
404InvalidEcsId.NotFound%sThe specified instance ID does not exist.
404InvalidEniId.NotFound%sThe specified ENI ID does not exist.
404InvalidVSwitchId.NotFound%sThe specified vSwitch does not exist.
404InvalidSecurityGroupId.NotFound%sThe specified security group ID does not exist.
404InvalidInstanceId.NotFound%sThe specified instance does not exist. Check whether the InstanceId parameter is valid.
404InvalidOperation.VSwitchCidrReservationNotExistThe specified vSwitch has no cidr reservation.-
500InvalidOperation.RegionNotSupportIpPrefixThe current region does not support ip prefix.You cannot assign IP address prefixes in this region.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-08-17The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    delete Error Codes: 403
    delete Error Codes: 404
    delete Error Codes: 500
2023-04-26The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 404 change
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 500