Call UnassignPrivateIpAddresses to unassign secondary private IP addresses and IPv4 prefixes from an ENI - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Unassigns secondary private IP addresses from an elastic network interface (ENI).

Operation description

Usage notes

The ENI from which to unassign secondary private IP addresses must be in the Available (Available) or InUse (InUse) state.
If the ENI is a primary ENI, the Elastic Compute Service (ECS) instance to which the ENI is attached must be in the Running (Running) or Stopped (Stopped) state.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:UnassignPrivateIpAddresses

delete

*NetworkInterface

acs:ecs:{#regionId}:{#accountId}:eni/{#eniId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the ENI. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
RegionId	string	Yes	The region ID of the ENI. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
NetworkInterfaceId	string	Yes	The ID of the ENI.	eni-bp67acfmxazb4ph****
PrivateIpAddress	array	No	The secondary private IP addresses to unassign.	192.168..
	string	No	Secondary private IP address N to unassign. Valid values of N: 1 to 32.	192.168..
Ipv4Prefix	array	No	The IPv4 prefixes to unassign.
	string	No	IPv4 prefix N to unassign. Valid values of N: 1 to 10.	192.168../28

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	UnsupportedParameter	%s	The parameter is not supported.
400	InvalidParameter	%s	The specified parameter is invalid.
400	InvalidInstanceID.Malformed	%s	The specified InstanceId parameter is invalid.
400	InvalidOperation.InvalidEcsState	%s
400	InvalidOperation.InvalidEniState	%s
400	InvalidOperation.DetachPrimaryEniNotAllowed	%s
400	MissingParameter	%s	A parameter is not specified.
400	Forbidden.RegionId	%s	The service is unavailable in the current region.
400	InvalidAction	%s	The operation is invalid.
400	InvalidEniId.Malformed	The specified parameter "EniId" is not valid.
400	InvalidParameter.Conflict	%s	The specified parameter is invalid. Check whether parameter conflicts exist. %s is a variable. An error message is dynamically returned based on call conditions.
500	InvalidOperation.RegionNotSupportIpPrefix	The current region does not support ip prefix.	You cannot assign IP address prefixes in this region.
403	InvalidUserType.NotSupported	%s	Your account does not support this operation.
403	Abs.InvalidAccount.NotFound	%s	Your Alibaba Cloud account does not exist or your AccessKey pair has expired.
403	MissingParameter	%s
403	Forbidden.NotSupportRAM	%s	RAM users are not authorized to perform this operation.
403	Forbidden.SubUser	%s	You are not authorized to manage this resource. Contact the owner of the Alibaba Cloud account for authorization.
403	MaxEniCountExceeded	%s	The maximum number of ENIs that can be managed has been reached.
403	EniPerInstanceLimitExceeded	%s	The maximum number of ENIs that can be attached to the specified instance has been reached.
403	InvalidOperation.AvailabilityZoneMismatch	%s	The operation is invalid.
403	InvalidOperation.VpcMismatch	%s	The operation is invalid. Check whether the VPC in the operation corresponds to other parameters.
403	SecurityGroupInstanceLimitExceed	%s
403	InvalidSecurityGroupId.NotVpc	%s	The specified SecurityGroupId parameter is invalid and the network type of the security group is not VPC.
403	InvalidOperation.InvalidEniType	%s
403	InvalidVSwitchId.IpInvalid	%s	The specified private IP address is invalid.
403	InvalidIp.IpUnassigned	%s	The specified IP address is not assigned.
403	Operation.Conflict	%s	This operation conflicts with another operation in progress. Try again later.
403	InvalidOperation.EniServiceManaged	%s	The operation is invalid.
403	InvalidPrivateIpAddress.Malformed	%s
403	InvalidIp.IpPrefixMaskInvalid	The 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.
403	InvalidIp.IpPrefixMaskNotSame	The ip prefixes %s are illegal which mask must be same.	The IP address prefix masks are not the same.
403	InvalidIp.IpPrefixNotStrict	The ip prefix must be strict cidr format.	The IP address prefix is invalid and is not in the CIDR format.
403	InvalidIp.IpPrefixIllegal	The ip prefixes %s is/are illegal.	The IP address prefix is invalid and is not in the CIDR format.
403	InvalidIp.IpRepeated	The specified ipAddress %s is(are) repeated.	The specified IP addresses already exist.
404	InvalidEcsId.NotFound	%s	The specified instance ID does not exist.
404	InvalidEniId.NotFound	%s
404	InvalidVSwitchId.NotFound	%s	The specified vSwitch does not exist.
404	InvalidSecurityGroupId.NotFound	%s	The specified security group ID does not exist.
404	InvalidInstanceId.NotFound	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.