Listing Scheduled Events

Function

This API is used to list scheduled events of an instance.

Debugging

You can debug this API in API Explorer.

Authorization

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
If you are using identity policy-based authorization, the permissions listed below are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
ecs:instanceScheduledEvents:list	list	-	-	-	-

URI

GET /v3/{project_id}/instance-scheduled-events

Table 1 describes the parameters in the URI.

**Table 1** Path parameter
Parameter	Mandatory	Description
project_id	Yes	Definition Specifies the project ID. For details about how to obtain the ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Definition Specifies the limit on the number of events that can be returned. Constraints N/A Range 1-100 Default Value N/A
marker	No	String	Definition Specifies the unique marker of the last record on the previous page. Constraints N/A Range N/A Default Value N/A
id	No	String	Definition Specifies the event ID. Constraints N/A Range N/A Default Value N/A
instance_id	No	String	Definition Specifies the instance ID. Constraints N/A Range N/A Default Value N/A
type	No	Array of strings	Definition Specifies the event type. Constraints N/A Range instance-reboot: instance restart instance-stop: instance stop instance-migrate: instance migration instance-redeploy: instance redeployment localdisk-recovery: local disk replacement system-maintenance: system maintenance For details, see Event Overview. Default Value N/A
state	No	Array of string	Definition Specifies the event status. Constraints N/A Range inquiring: An event is pending authorization with a specified start time. The system will complete operations within the specified time. For details, see Handling an Event. scheduled: The event is waiting for the system to schedule resources. executing: The system has scheduled resources and is rectifying the fault. completed: The system has completed the event execution. Check the impacts on services. If any problems occur, contact technical support. failed: The system fails to automatically rectify the fault. canceled: The event has been canceled by the system. For details, see Event Overview. Default Value N/A
publish_since	No	String	Definition Specifies the start time of publishing an event. The value is filtered by time range. Constraints The value is in the format of "yyyy-MM-ddTHH:mm:ssZ" in UTC+0 and complies with ISO8601. Range N/A Default Value N/A
publish_until	No	String	Definition Specifies the end time of publishing an event. The value is filtered by time range. Constraints The value is in the format of "yyyy-MM-ddTHH:mm:ssZ" in UTC+0 and complies with ISO8601. Range N/A Default Value N/A

Request

None.

Response

Table 3 describes the response parameter.

**Table 3** Response parameters
Parameter	Type	Description
events	Array of objects	Definition Specifies the event list. For details, see Table 4. Range N/A
page_info	Object	Definition Specifies the page marker. For details, see Table 5. Range N/A

**Table 4** **events** parameters
Parameter	Type	Description
id	String	Definition Specifies the event ID. Range N/A
type	String	Definition Specifies the event type. Range instance-reboot: instance restart instance-stop: instance stop instance-migrate: instance migration instance-redeploy: instance redeployment localdisk-recovery: local disk replacement system-maintenance: system maintenance For details, see Event Overview.
state	String	Definition Specifies the event status. Range inquiring: An event is waiting to be authorized with the start time specified. The system will complete operations within a specified time. For details, see the response event. scheduled: The event is waiting for the system to schedule resources. executing: The system has scheduled resources and is rectifying the fault. completed: The system has completed the event execution. Check the impacts on services. If any problems occur, contact technical support. failed: The system fails to automatically rectify the fault. canceled: The event has been canceled by the system.
publish_time	String	Definition Specifies when the event is published. Range N/A
start_time	String	Definition Specifies the event start time. Range N/A
finish_time	String	Definition Specifies the event completion time. Range N/A
not_before	String	Definition Specifies when the event is scheduled to start. Range N/A
not_after	String	Definition Specifies when the event is scheduled to end. Range N/A
not_before_deadline	String	Definition Specifies the deadline of starting a scheduled event. Range N/A
description	String	Definition Specifies the event description. Range N/A
instance_id	String	Definition Specifies the instance ID. Range N/A
execute_options	Object	Definition Specifies the event execution option. For details, see Table 6. Range N/A
source	Object	Definition Specifies the event source. For details, see Table 7. Range N/A

**Table 5** **page_info** parameters
Parameter	Type	Description
next_marker	String	Definition Specifies the query address of the next page. Range N/A

**Table 6** **execute_options** field description
Parameter	Type	Description
device	String	Definition Specifies the device name of the local disk. Range N/A
wwn	String	Definition Specifies the unique ID used for attaching the local disk. Range N/A
serial_number	String	Definition Specifies the SN of the local disk. Range N/A
resize_target_flavor_id	String	Definition Specifies the flavor ID. Range N/A
migrate_policy	String	Definition Specifies the instance migration policy. Range N/A
executor	String	Definition Specifies the executor. Range N/A

**Table 7** **source** field description
Parameter	Type	Description
type	String	Definition Specifies the source type of the scheduled event. Range platform: The event is initiated by the O&M platform. user: The event is initiated by users.
host_scheduled_event_id	String	Definition Specifies the ID of the scheduled event for the host. Range N/A

Example Request

List scheduled events.

GET https://{endpoint}/v3/{project_id}/instance-scheduled-events?state=inquiring,scheduled,executing&limit=1

Example Response

{
    "events": [
        {
            "id": "0ead944a-72e8-494f-89ba-5846fb7ac5c0",
            "type": "instance-redeploy",
            "state": "scheduled",
            "publish_time": "2025-03-13T12:55:36Z",
            "start_time": null,
            "finish_time": null,
            "not_before": "2025-03-21T09:22:41Z",
            "not_after": "2025-03-21T11:22:41Z",
            "not_before_deadline": "2025-03-21T09:22:41Z",
            "description": "{\"en-us\":\"As being affected by underlying hardware or system OM, ECSs will be redeployed on new hosts\"}",
            "instance_id": "c51b9e4f-0469-4c6f-ad03-22b23247b7a8"
        }
    ],
    "page_info": {
        "next_marker": "0ead944a-72e8-494f-89ba-5846fb7ac5c0"
    }
}