Automate Batch ENS Instance Migration with BatchEventMigrateInstance - ENS

Operation description

Description

This operation currently supports only the Instance:SystemUpgrade.Migrate event type. This event is triggered when an instance must be migrated due to an underlying system upgrade.

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

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
EventInfos	array<object>	No	A list of events.
	object	No	An event object.
EventId	string	Yes	The event ID. The ID must be in the `e-*` format.	e-d71ff150945b9c02eb6ebc0016328468
ResourceId	string	Yes	The resource ID. The ID must be in the `i-*` format.	i-55qi8m11rr53c4i964md8a00l
PlanTime	integer	No	The scheduled execution time as a Unix timestamp in milliseconds. This parameter is required if you set `OpsType` to `scheduled`.	1742452232000
OpsType	string	Yes	The operation type. Valid values: `immediate`: Executes the migration immediately. `scheduled`: Schedules the migration for the time specified by the `PlanTime` parameter.	immediate
DataPolicy	string	No	The data migration policy. Valid values: `abandon`: Do not migrate data. This is the default value. `force_transfer`: Forcibly migrates data. `try_transfer`: Attempts to migrate data.	abandon
Password	string	No	The instance password. This parameter is optional. If this parameter is omitted, the system generates a random password. The password must be 8 to 30 characters long and contain uppercase and lowercase letters, and digits. Note: Passwords cannot be specified for scheduled executions.	AAaa1234
PlanUtcTime	string	No

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	FF53E96D-3F1A-42F0-8373-1C2B39D72D44
Results	array<object>	A list of results.
	object	A result object.
Code	integer	The status code.	200
EventId	string	The event ID.	e-d71ff150945b9c02eb6ebc0016328468
Message	string	The error message returned if `Code` is not `200`.	success
ResourceId	string	The resource ID.	i-55qi8m11rr53c4i964md8a00l

Examples

Success response

JSON format

{
  "RequestId": "FF53E96D-3F1A-42F0-8373-1C2B39D72D44",
  "Results": [
    {
      "Code": 200,
      "EventId": "e-d71ff150945b9c02eb6ebc0016328468",
      "Message": "success",
      "ResourceId": "i-55qi8m11rr53c4i964md8a00l\n"
    }
  ]
}

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.