All Products
Search
Document Center

ENS:AssignPrivateIpAddresses

Last Updated:Nov 18, 2024

Assigns secondary private IP addresses to an elastic network interface (ENI).

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
ens:AssignPrivateIpAddressescreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
NetworkInterfaceIdstringYes

The ID of the ENI.

eni-uf6533jbifugr5fo2j1w
VSwitchIdstringNo

The ID of the vSwitch.

vsw-5rllcjb3ol6duzjdnbm1ombn7

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

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

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

NetworkInterfaceIdstring

The ID of the ENI.

eni-uf620pb4d19ljnu4a64m
PrivateIpSetarray

The assigned private IP addresses.

PrivateIpSetstring

The assigned private IP address.

10.0.0.5

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400Invalid%sThe specified parameter %s is invalid.-
400Missing%sYou must specify the parameter %s.-
400ens.interface.errorAn error occurred while calling the API.-
400InvalidEniId.NotFoundThe specified NetworkInterfaceId does not exist. -
400IncorrectInstanceStatusThe current status of the resource does not support this operation.The current operation is not supported. The disk is being reset.
400InvalidOperation.InstanceNotSupportThe specified instance does not support this operation. -
400InvalidVSwitchId.NotFoundThe specified VSwitchId does not exist.-
400InvalidVSwitchId.NotBelongNetworkThe specified VSwitch is not bound to instance's network.-
400MaxEniPrivateIpsCountExceededThe maximum number of privateIp in a eni is exceeded.-
400InvalidVSwitchId.IpNotEnoughDon't have enough private IPs in this switch.-
400IncorrectEniStatusCurrent eni status does not support this operation. -
400InvalidParameter.EniServiceManagedThe eni is managed by service.-
400NoPermissionPermission denied.-
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

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

Change history

Change timeSummary of changesOperation
2023-09-21The Error code has changedView Change Details