All Products
Search

This Product

    Elastic Compute Service:UnassignPrivateIpAddresses

    Document Center

    Elastic Compute Service:UnassignPrivateIpAddresses

    Last Updated:Nov 14, 2024

    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.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    ecs:UnassignPrivateIpAddressesdelete
    *NetworkInterface
    acs:ecs:{#regionId}:{#accountId}:eni/{#eniId}
      none
    		none

    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-bp67acfmxazb4ph****
    PrivateIpAddressarrayNo

    The secondary private IP addresses to unassign.

    stringNo

    Secondary private IP address N to unassign. Valid values of N: 1 to 32.

    		192.168.**.**
    Ipv4PrefixarrayNo

    The IPv4 prefixes to unassign.

    stringNo

    IPv4 prefix N to unassign. Valid values of N: 1 to 10.

    		192.168.**.**/28

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    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.-
    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.IpInvalid%sThe specified private IP address is invalid.
    403InvalidIp.IpUnassigned%sThe specified IP address is not assigned.
    403Operation.Conflict%sThis operation conflicts with another operation in progress. Try again later.
    403InvalidOperation.EniServiceManaged%sThe operation is invalid.
    403InvalidPrivateIpAddress.Malformed%s-
    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.IpPrefixNotStrictThe ip prefix must be strict cidr format.The IP address prefix is invalid and is not in the CIDR format.
    403InvalidIp.IpPrefixIllegalThe ip prefixes %s is/are illegal.The IP address prefix is invalid and is not in the CIDR format.
    403MissingParameterThese parameters %s cannot be both 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.
    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
    No change history