All Products
Search
Document Center

ENS:EventMigrateInstance

Last Updated:Oct 26, 2026

Migrates an instance across nodes after an O&M event occurs on the instance.

Operation description

  • This O&M operation currently supports only the following event type: Instance:SystemUpgrade.Migrate (migration required for underlying upgrades).

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

none

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

EventId

string

Yes

The ID of the system event.

e-d71ff150945b9c02eb6ebc0016328468

ResourceId

string

Yes

The ID of the resource.

i-55qi8m11rr53c4i964md8a00l

OpsType

string

Yes

The type of the O&M task. Valid values:

  • immediate: Executes the task immediately.

  • scheduled: Executes the task at a scheduled time.

immediate

PlanTime

integer

No

The scheduled execution time. The value is a timestamp in milliseconds. This parameter is required when OpsType is set to scheduled.

1742452232000

PlanUtcTime

string

No

The scheduled UTC time.

DataPolicy

string

No

The data migration policy. Valid values:

  • abandon: Does not migrate data. This is the default value.

  • force_transfer: forcible migration of EPS resource.

  • try_transfer: Attempts to migrate data.

abandon

Password

string

No

The instance password. This parameter is optional. If you do not specify this parameter, a random password is used.

The password must be 8 to 30 characters in length and must contain uppercase letters, lowercase letters, and digits.

Note: You cannot specify a password when you schedule the execution time.

AAaa1234

Response elements

Element

Type

Description

Example

object

The return values.

RequestId

string

The ID of the request.

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 NoPermission Permission denied.
400 InvalidParameter.%s The specified field %s invalid. Please check it again.
400 Throttling.Api Request was denied due to flow control. request to trigger flow control

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.