You can call this operation to assign one or more secondary private IP addresses to an Elastic Network Interface (ENI). You can specify private IP addresses within the CIDR block of the VSwitch to which the ENI is connected. Alternatively, you can specify the number of private IP addresses for ECS to assign them automatically.

Description

  • The ENI to which you want to assign IP addresses must be in the Available (Available) or Bound (InUse) state.
  • When you perform operations on the primary ENI, the instance to which the ENI is attached must be in the Running or Stopped state.
  • When an ENI is in the Available state, you can assign up to 10 secondary private IP addresses to the ENI. When an ENI is attached to an instance, the number of private IP addresses that can be assigned to the ENI is subject to the instance type. For more information, see Instance families.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
NetworkInterfaceId String Yes eni-bp67acfmxazb4ph***

The ID of the ENI.

RegionId String Yes cn-hangzhou

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

Action String No AssignPrivateIpAddresses

The operation that you want to perform. Set the value to AssignPrivateIpAddresses.

PrivateIpAddress.N RepeatList No 10.1.2.1

One or more secondary private IP addresses selected from the CIDR block of the VSwitch to which the ENI is connected. Valid values of N:

  • When the ENI is in the Available (Available) state: 1 to 10.
  • When the ENI is in the Bound (InUse) state: limited by the instance type. For more information, see Instance families.

You cannot specify both PrivateIpAddress.N and SecondaryPrivateIpAddressCount at the same time.

SecondaryPrivateIpAddressCount Integer No 1

The number of idle private IP addresses that are automatically allocated from within the CIDR block of the VSwitch.

Response parameters

Parameter Type Example Description
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

The ID of the request.

Examples

Sample requests

https://ecs.aliyuncs.com/?Action=AssignPrivateIpAddresses
&NetworkInterfaceId=eni-bp67acfmxazb4ph***
&RegionId=cn-hangzhou
&PrivateIpAddress.1=10.1.2.1
&PrivateIpAddress.2=10.1.2.2
&<Common request parameters>

Sample responses

XML format

<AssignPrivateIpAddressesResponse>
      <RequestId>04F0F334-1335-436C-A1D7-6C044FE70008</RequestId>
</AssignPrivateIpAddressesResponse>

JSON format

{
	"RequestId":"04F0F334-1335-436C-A1D7-6C044FE70008"
}

Error codes

HTTP status code Error code Error message Description
403 InvalidUserType.NotSupported %s The error message returned because you are not authorized to perform this operation.
403 Abs.InvalidAccount.NotFound %s The error message returned because the specified Alibaba Cloud account does not exist or your AccessKey has expired.
403 MissingParameter %s The error message returned because a required parameter is not specified.
403 Forbidden.NotSupportRAM %s The error message returned because the RAM user is not allowed to perform this operation.
400 UnsupportedParameter %s The error message returned because a parameter is not supported.
403 Forbidden.SubUser %s The error message returned because the RAM user is not authorized to perform operations on this resource.
400 InvalidParameter %s The error message returned because the parameter format is invalid.
400 InvalidInstanceID.Malformed %s The error message returned because the instance ID format is invalid.
400 InvalidOperation.InvalidEcsState %s The error message returned because the operation is not supported while the instance is in the current state.
400 InvalidOperation.InvalidEniState %s The error message returned because the operation is not supported while the ENI is in the current state.
400 InvalidOperation.DetachPrimaryEniNotAllowed %s The error message returned because the primary ENI cannot be detached from its instance.
404 InvalidEcsId.NotFound %s The error message returned because the specified instance ID does not exist.
404 InvalidEniId.NotFound %s The error message returned because the specified ENI ID does not exist.
404 InvalidVSwitchId.NotFound %s The error message returned because the specified VSwitch ID does not exist.
404 InvalidSecurityGroupId.NotFound %s The error message returned because the specified security group ID does not exist.
403 MaxEniCountExceeded %s The error message returned because the maximum number of ENIs in the specified region has been reached.
403 EniPerInstanceLimitExceeded %s The error message returned because the maximum number of ENIs for the specified instance type has been reached.
403 InvalidOperation.AvailabilityZoneMismatch %s The error message returned because the specified VSwitch, ENI, and instance do not belong to the same zone.
403 InvalidOperation.VpcMismatch %s The error message returned because the specified ENI and security group do not belong to the same VPC.
403 SecurityGroupInstanceLimitExceed %s The error message returned because the maximum number of instances in the specified security group has been reached.
403 InvalidSecurityGroupId.NotVpc %s The error message returned because the specified security group is not VPC-type.
403 InvalidOperation.InvalidEniType %s The error message returned because the ENI type does not support the operation.
404 InvalidInstanceId.NotFound %s The error message returned because the specified instance does not exist.
403 InvalidVSwitchId.IpNotEnough %s The error message returned because IP addresses in the specified VSwitch are insufficient.
403 InvalidVSwitchId.IpInvalid %s The error message returned because the specified private IP address is invalid.
403 InvalidIp.IpAssigned %s The error message returned because the specified IP address is already assigned.
403 Operation.Conflict %s The error message returned because operations conflict. Try again.
400 Forbidden.RegionId %s The error message returned because this feature is not supported in the region.
400 InvalidAction %s The error message returned because the operation is invalid.
403 InvalidOperation.Ipv4CountExceeded %s The error message returned because the maximum number of IPv4 addresses has been reached.
403 InvalidOperation.EniServiceManaged %s The error message returned because this operation is invalid.

For a list of error codes, visit the API Error Center.