Use CreateSimulatedSystemEvents to schedule simulated system events for ECS instances - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Operation description

After you schedule a simulated event, you can view the scheduled simulated system event in the ECS console, by invoking ECS API operations, or by using CloudMonitor monitoring.

The following table describes the lifecycle of a simulated system event:

Scheduled: After you schedule a simulated system event, the event automatically switches to the Scheduled state via automatic switchover.
Executed: The simulated system event automatically enters the Executed state at the specified time (NotBefore) if no manual intervention is performed.
Canceled: The simulated system event enters the Canceled state after you call CancelSimulatedSystemEvents to cancel the event.
Avoided: For a simulated system event of the SystemMaintenance.Reboot type, the event enters the Avoided state if you restart the instance before the specified time.

Take note of the following items when you set TriggerRealOps to true in Settings:

Warning The system actually stops or releases the instance, which may cause data loss. Exercise caution when you perform this operation, or use instances that do not run workloads for testing.
EventType supports only SystemMaintenance.Reboot, SystemMaintenance.Redeploy, SystemMaintenance.Stop, InstanceFailure.Reboot, SystemFailure.Reboot, and Instance:PreemptibleInstanceInterruption.
When EventType is set to SystemMaintenance.Redeploy, the NotBefore parameter is invalid. The system automatically generates the execution time of the event.

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

ecs:CreateSimulatedSystemEvents

create

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
EventType	string	Yes	The type of the system event. Valid values: SystemMaintenance.Reboot: The instance is restarted due to system maintenance. SystemFailure.Reboot: The instance is restarted due to a system error. InstanceFailure.Reboot: The instance is restarted due to an instance error. SystemMaintenance.Stop: The instance is stopped due to system maintenance. SystemMaintenance.Redeploy: The instance is redeployed due to system maintenance. SystemFailure.Redeploy: The instance is redeployed due to a system error. SystemFailure.Stop: The instance is stopped due to a system error. InstanceFailure.Reboot: The instance is restarted due to an instance error.	SystemMaintenance.Reboot
NotBefore	string	Yes	The scheduled start time of the event. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note For unexpected events caused by system errors or instance errors, the event is already in the Executing state after it is created. In this case, the NotBefore parameter specifies the time when the event enters the Executed state.	2018-12-01T06:32:31Z
InstanceId	array	Yes	The list of ECS instance IDs. You can specify up to 100 instance IDs.	i-bp1gtjxuuvwj17zr****
	string	No	The instance ID.	i-bp1gtjxuuvwj17zr****
		No	Specifies whether to trigger real O&M operations. Valid values: - true: Triggers real O&M operations. The system actually stops or releases the instance. Exercise caution when you perform this operation, or use instances that do not run workloads for testing. - false (default): Only simulates event notifications without affecting the actual lifecycle of the instance.	false

Response elements

Element	Type	Description	Example
	object	The request ID.
EventIdSet	object
EventId	array	The list of simulated event IDs (EventId).
	string	The simulated event ID (EventId).	e-bp16helosl7v0ooj****
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Success response

JSON format

{
  "EventIdSet": {
    "EventId": [
      "e-bp16helosl7v0ooj****"
    ]
  },
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error codes

HTTP status code	Error code	Error message	Description
403	InvalidParameter	%s
403	InvalidNotBefore.Passed	%s	The specified value of NotBefore is earlier than the current time.
403	SimulatedEventLimitExceeded	%s	The simulated event limit has been exceeded.
403	InstanceIdLimitExceeded	%s	More than 100 instance IDs are specified.
404	MissingParameter	%s
404	InvalidInstanceId.NotFound	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.