Updated on 2026-11-12 GMT+08:00

Obtaining the Scheduled Event List

Function

This API is used to obtain the scheduled event list.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

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

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    modelarts:pool:list

    List

    pool *

    -

    -

    • modelarts:workspace:get
    • modelarts:workspace:list

    -

    • g:EnterpriseProjectId

    • g:RequestTag/<tag-key>

    • g:TagKeys

URI

GET /v1/{project_id}/scheduled-events

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition: User project ID. For details, see Obtaining a Project ID and Name.

Constraints: N/A

Range: N/A

Default Value: N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

workspaceId

No

String

Definition: Workspace ID. The default value is 0. The value is the id field in the API for querying the workspace list.

Constraints: The value is automatically generated by the system. It must start with a lowercase letter and consist of digits and hyphens (-). It cannot end with a hyphen (-) and can contain no more than 63 characters.

Range: N/A

Default Value: N/A

state

No

Array of strings

Definition: Event status.

Constraints: N/A

Range:

  • inquiring: To be authorized.

  • scheduled: To be executed.

  • executing: Being executed.

  • completed: Executed.

  • failed: Execution failed.

canceled: Canceled.

Default Value: N/A

type

No

Array of strings

Definition: Event type.

Constraints: N/A.

Range:

  • system-maintenance: System maintenance

  • localdisk-recovery: Local disk recovery

  • node_reboot: Node reboot

  • operation-request: O&M authorization

  • node_maintenance: Supernode maintenance

  • node_redeploy: Supernode redeployment

  • node_localdisk_recovery: Supernode local disk recovery

Default Value: N/A.

id

No

Array of strings

Definition: Scheduled event ID. The value is the event_id field in the API for querying the scheduled event list. Batch filtering is supported. A maximum of 100 parameters can be specified.

Constraints: The value is automatically generated by the system. It must start with a lowercase letter and cannot end with a hyphen (-). The value can contain at most 63 characters. Digits and hyphens (-) are allowed.

Range: N/A

Default Value: N/A

nodeName

No

String

Definition: Node name, which is the value of metadata.name in the node details.

Constraints: The value is automatically generated by the system. It must start with a lowercase letter and consist of digits and hyphens (-). It cannot end with a hyphen (-) and can contain no more than 63 characters.

Range: N/A.

Default Value: N/A.

poolName

No

String

Definition: Name of the resource pool. This parameter is only available for lite-cluster and standard. The value is obtained from the metadata.name field in resource pool details. This parameter can be transferred when you query the scheduled events of nodes in a specified standard cluster or lite cluster.

Constraints: The value is automatically generated by the system. It must start with a lowercase letter and consist of digits and hyphens (-). It cannot end with a hyphen (-) and can contain no more than 63 characters.

Range: N/A.

Default Value: N/A.

publishStartTime

No

String

Definition: 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.

publishEndTime

No

String

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

offset

No

Integer

Definition: Offset where a query starts.

Constraints: N/A.

Range: [0, 1000000000].

Default Value: 0.

limit

No

Integer

Definition: Maximum number of records returned per page.

Constraints: N/A.

Range: [1, 100].

Default Value: 100.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response header parameters

Parameter

Type

Description

X-request-id

String

This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname.

Table 4 Response body parameters

Parameter

Type

Description

events

Array of ScheduledEvent objects

'Definition: Scheduled event list.

count

Integer

Definition: Total number of scheduled events.

Range: N/A.

Table 5 ScheduledEvent

Parameter

Type

Description

id

String

Event ID.

catalog

String

Definition: Event category.

Range: N/A

isHyperNode

String

Definition: Supernode ID.

Range: true or false

type

String

Definition: Event type.

Range:

  • system-maintenance: system maintenance

  • localdisk-recovery: local disk recovery

  • node_reboot: node reboot

  • operation-request: O&M authorization

  • node_maintenance: supernode maintenance

  • node_redeploy: supernode redeployment

  • node_localdisk_recovery: supernode local disk recovery

description

String

Description.

state

String

Definition: Event status.

Range

  • inquiring: To be authorized.

  • scheduled: To be executed.

  • executing: Being executed.

  • completed: Executed.

  • failed: Execution failed.

  • canceled: Canceled.

  • part-completed: Partially successful.

publishTime

String

Definition: Event release time.

Range: N/A

startTime

String

Definition: Event start time.

Range: N/A

finishTime

String

Definition: Event completion time.

Range: N/A

notBefore

String

Definition: Planned start time of the event, in UTC time string format, for example, 2025-09-15T07:02:30Z.

Range: N/A

probeMsg

String

Definition: Prompt information.

Range: N/A

executeOptions

ExecuteOptions object

Definition: Execution option.

Range: N/A

redeployType

Array of strings

Definition: Node redeployment type list, indicating the redeployment types supported by the scheduled event.

Range

  • SOFT: Redeployment is supported.

  • HARD: Forcible redeployment is supported.

autoRecoveryCheckTime

String

Definition: Time when the event is automatically authorized by the system. The value is a UTC time string, for example, 2025-09-15T07:02:30Z.

Range: N/A

nodes

Array of NodeEvent objects

Definition: List of information about nodes associated with the event.

Range: N/A

instanceId

String

Definition: Node ID. Instance ID automatically generated by the compute service system. The length of the ID is fewer than 63 characters.

Range: N/A

nodeName

String

Definition: Node name, which is the value of metadata.name in the node details. The value is automatically generated by the system. It must start with a lowercase letter and consist of digits and hyphens (-). It cannot end with a hyphen (-) and can contain no more than 63 characters.

Range: N/A

instanceType

String

Definition: Node type.

Range:

  • devserver: lite-server node

  • lite-cluster: lite pool

  • standard: standard pool

underLyingInstanceId

String

Definition: ID of the ECS in the supernode scenario. Instance ID automatically generated by the compute service system. The length of the ID is fewer than 63 characters.

Range: This parameter is involved in supernodes and is not involved in snt9b.

flavorSupportRedeploy

Boolean

Definition: Whether the flavor supports redeployment.

Range: true or false

poolName

String

Definition: Name of the resource pool. This parameter is only available for lite-cluster and standard. The value is obtained from the metadata.name field in resource pool details. The value is automatically generated by the system. It must start with a lowercase letter and consist of digits and hyphens (-). It cannot end with a hyphen (-) and can contain no more than 63 characters.

Range: N/A

poolDisplayName

String

Definition: Name of the resource pool displayed externally. This parameter is only available for lite-cluster and standard. The value is obtained from the metadata.labels field in resource pool details. The value can contain 36 to 63 characters. It must start with a lowercase letter and cannot end with a hyphen (-). Digits and hyphens (-) are allowed.

Range: N/A

jobProgress

String

Definition: Real-time progress of the redeployment execution, which is automatically generated by the system.

Range: N/A

Table 6 ExecuteOptions

Parameter

Type

Description

serialNumber

String

Definition: Serial number.

Table 7 NodeEvent

Parameter

Type

Description

eventId

String

Definition: ID of an IaaS scheduled event.

Range: N/A

isFaultNode

Boolean

Definition: Whether the node is faulty.

Range: N/A

nodeName

String

Definition: Node name.

Range: N/A

instanceId

String

Definition: Node ID.

Range: N/A

instanceType

String

Definition: Instance type.

Range: N/A

underLyingInstanceId

String

Definition: Underlying instance ID.

Range: N/A

flavorSupportRedeploy

Boolean

Definition: Whether the node flavor supports redeployment.

Range: N/A

poolName

String

Definition: Resource pool name.

Range: N/A

poolDisplayName

String

Definition: Display name of a resource pool.

Range: N/A

state

String

Definition: Status of an IaaS scheduled event.

Range: N/A

publishTime

String

Definition: Time when an IaaS event was published.

Range: N/A

startTime

String

Definition: IaaS event start time.

Range: N/A

finishTime

String

Definition: Time when an IaaS event was completed.

Range: N/A

jobProgress

String

Definition: Redeployment progress.

Range: N/A

Status code: 400

Table 8 Response header parameters

Parameter

Type

Description

X-request-id

String

This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname.

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

None

Example Responses

Status code: 200

{
  "events" : [ {
    "id" : "ma-event-e2df806e",
    "catalog" : "hardware",
    "isHyperNode" : "true",
    "type" : "system-maintenance",
    "description" : "",
    "state" : "canceled",
    "publishTime" : "2026-08-05T10:23:25Z",
    "probeMsg" : "",
    "nodes" : [ {
      "eventId" : "event-001",
      "isFaultNode" : true,
      "nodeName" : "node-7a3b2c1d",
      "instanceId" : "instance-8e4c3d2e9f7a5b6c1d0e4f5a6b7c8d9e",
      "instanceType" : "standard",
      "underLyingInstanceId" : "underlyinginstance-25f392f0b3e6",
      "flavorSupportRedeploy" : true,
      "poolName" : "pool-2c1d3e4f5a6b7c8d",
      "poolDisplayName" : "pool-2c1d3e4f5a6b7c8d9e0f1a2b3c4d5e6",
      "state" : "canceled",
      "publishTime" : "2026-08-05T10:23:25Z"
    } ],
    "instanceId" : "instance-8e4c3d2e9f7a5b6c1d0e4f5a6b7c8d9e",
    "nodeName" : "node-7a3b2c1d",
    "instanceType" : "standard",
    "underLyingInstanceId" : "underlyinginstance-25f392f0b3e6",
    "flavorSupportRedeploy" : true,
    "poolName" : "pool-2c1d3e4f5a6b7c8d",
    "poolDisplayName" : "pool-2c1d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
  } ],
  "count" : 1
}

Status Codes

Status Code

Description

200

Response to the request for querying the scheduled event list.

400

Error response

Error Codes

See Error Codes.