Modify ENS Instance Private IP and vSwitch via API - ENS

Modifies the private IP address or vSwitch of a VPC-type ECS instance.

Operation description

The instance that you want to manage must be in the Stopped state. When you modify the parameters of a scaling group, the following limits apply:

Instance:
- Instances that are associated with SLB are not supported.
Network:
- Instances that are associated with EIPs are not supported.
- Instances that are associated with high-availability virtual IP addresses are not supported.
- Instances that have been used as next hops in the routing table are not supported.
- Secondary ENIs cannot be attached to the ECS instance.
- Instances configured with secondary IP addresses are not supported.

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:ModifyInstanceNetworkAttribute

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the ENS instance.	i-5myukg7hnpbto7m024002****
VSwitchId	string	No	The vSwitch IDs. If you set this parameter to the ID of the current vSwitch, the vSwitch of the ECS instance remains unchanged. The input ID is a new vSwitch, and the new and old vSwitches must belong to the same node. By default, if this parameter is not specified, a private IP address is randomly assigned from within the CIDR block of the specified vSwitch.	vsw-5rllcjb3ol6duzjdnbm1o****
PrivateIpAddress	string	No	The new private IP address of the ECS instance. By default, if this parameter is empty, a private IP address is randomly assigned from the CIDR block of the specified vSwitch.	192.168.XX.XX

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	125B04C7-3D0D-4245-AF96-14E3758E3F06

Examples

Success response

JSON format

{
  "RequestId": "125B04C7-3D0D-4245-AF96-14E3758E3F06"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ens.interface.error	Failed to call API.
400	InvalidDependence.%s	The Specified operation is denied due to %s.	The instance has dependencies and cannot be modified.
400	InvalidInstanceId.NotFound	The specified InstanceId does not exist.	The specified instance 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	InvalidInstanceType.NotSupported	The specified InstanceType is not Supported.	The specified instance type does not support the current operation.
400	IncorrectNetworkInterfaceStatus	The operation could not be completed because the status of the specified network interface is invalid for this action.	The operation could not be completed because the status of the specified network interface is invalid for this action.
400	InvalidVSwitchId.NotFound	Specified virtual switch does not exist.	The specified virtual switch ID does not exist.
400	IncorrectVSwitchStatus	The current status of virtual switch does not support this operation.	The specified virtual switch is not available and cannot operate.
400	InvalidPrivateIpAddress.Mismatch	Specified private IP address is not in the CIDR block of virtual switch.	The specified private IP address is not in the CIDR block of the specified VSwitch.
400	InvalidPrivateIpAddress.Duplicated	The specified private IP address is duplicated.	The specified IP address is already in use.
400	InvalidVSwitchId.IpNotEnough	The specified virtual switch has not enough available ip.	The number of IP addresses in the specified switch is insufficient.
400	Invalid%s	The specified parameter %s is invalid.
400	Missing%s	You must specify the parameter %s.
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.