Assign Secondary Private IPs to ENI with AssignPrivateIpAddresses - ENS

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

ens:AssignPrivateIpAddresses

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
NetworkInterfaceId	string	Yes	The ID of the ENI.	eni-uf6533jbifugr5f*****
VSwitchId	string	No	The ID of the vSwitch.	vsw-5rllcjb3ol6duzjdnbm1o*****

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
AssignedPrivateIpAddressesSet	object	Details about the ENI and the secondary private IP addresses that are assigned to the ENI.
NetworkInterfaceId	string	The ID of the ENI.	eni-uf620pb4d19ljnu4a64m
PrivateIpSet	array	The assigned private IP addresses.
	string	The assigned private IP address.	10.0.XXX

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "AssignedPrivateIpAddressesSet": {
    "NetworkInterfaceId": "eni-uf620pb4d19ljnu4a64m",
    "PrivateIpSet": [
      "10.0.XXX"
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid%s	The specified parameter %s is invalid.
400	Missing%s	You must specify the parameter %s.
400	ens.interface.error	An error occurred while calling the API.
400	InvalidEniId.NotFound	The specified NetworkInterfaceId does not exist.
400	IncorrectInstanceStatus	The current status of the resource does not support this operation.	The current operation is not supported. The disk is being reset.
400	InvalidOperation.InstanceNotSupport	The specified instance does not support this operation.
400	InvalidVSwitchId.NotFound	The specified VSwitchId does not exist.
400	InvalidVSwitchId.NotBelongNetwork	The specified VSwitch is not bound to instance's network.
400	MaxEniPrivateIpsCountExceeded	The maximum number of privateIp in a eni is exceeded.
400	InvalidVSwitchId.IpNotEnough	Don't have enough private IPs in this switch.
400	IncorrectEniStatus	Current eni status does not support this operation.
400	InvalidParameter.EniServiceManaged	The eni is managed by service.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.