Help Center/ ModelArts/ API Reference/ Scheduled Events/ Obtaining the Scheduled Event List
Updated on 2025-11-19 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.

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

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.

Table 5 ScheduledEvent

Parameter

Type

Description

id

String

Event ID.

catalog

String

Category.

type

String

Event type.

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

description

String

Description.

state

String

Event status.

inquiring: The request is to be authorized.

scheduled: The request has been authorized.

executing: The request is being executed.

completed: The request is completed.

failed: The request failed.

canceled: The request is canceled.

instanceType

String

Definition: node type.

Range:

  • devserver: lite-server node

  • lite-cluster: lite pool

  • standard: standard pool

instanceId

String

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

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.name 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

publishTime

String

Definition: Event release time.

Constraints: The value is a UTC time string, for example, 2025-09-15T07:02:30Z.

Range: N/A

Default Value: N/A

startTime

String

Definition: Start time of an event.

Constraints: The value is a UTC time string, for example, 2025-09-15T07:02:30Z.

Range: N/A

Default Value: N/A

finishTime

String

Definition: Event completion time.

Constraints: The value is a UTC time string, for example, 2025-09-15T07:02:30Z.

Range: N/A

Default Value: N/A

notBefore

String

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

Constraints: later than the current time.

Range: N/A

Default Value: If this parameter is left empty, the event is executed immediately.

probeMsg

String

Definition: Prompt information.

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

redeployType

Array of strings

Definition: Node redeployment type.

Constraints: N/A

Range: - HARD: forcible redeployment; - SOFT: redeployment

Default Value: N/A

Status code: 400

Table 6 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 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Response to the request for querying the scheduled event list.

400

Error response

Error Codes

See Error Codes.