文档首页/ 灵衢智算集群/ API参考/ API/ 计划事件/ 查询计划事件列表-ListScheduledEvents
更新时间：2026-10-08 GMT+08:00
在线调试
CLI示例
分享

查询计划事件列表-ListScheduledEvents

功能介绍

查询计划事件列表接口，用于获取当前项目下租户可见的计划事件，支持按事件类型、状态、集群、超节点、节点等条件过滤，仅返回最近7天内的计划事件。

该接口适用于以下场景：控制台查看计划事件进度、按节点或超节点筛选相关事件、事件授权与执行状态跟踪等。

查询完成后，将返回计划事件列表及分页信息。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

aics::listScheduledEvents

List

-

-

-

-

URI

GET /v2/{project_id}/scheduled-events

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID，获取方法请参见获取项目ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

id

否

String

参数解释:

计划事件ID，可以从查询计划事件列表接口的响应中获取。

约束限制:

不涉及。

取值范围:

UUID格式，[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}。

默认取值:

不涉及。

type

否

Array of strings

参数解释:

事件类型。

约束限制:

不涉及。

取值范围:

  • redeploy：重部署

  • system-maintenance：系统维护

  • localdisk-recovery：本地盘换盘

默认取值:

不涉及。

status

否

Array of strings

参数解释:

事件状态。

约束限制:

不涉及。

取值范围:

  • inquiring：待授权

  • scheduled：待执行

  • executing：执行中

  • completed：已完成

  • failed：失败

  • canceled：已取消

默认取值:

不涉及。

cluster_id

否

String

参数解释:

集群ID，可以从查询集群列表接口的响应中获取。

约束限制:

不涉及。

取值范围:

UUID格式，[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}。

默认取值:

不涉及。

hyper_node_id

否

Array of strings

参数解释:

超节点ID，可以从查询超节点列表接口的响应中获取。

约束限制:

不涉及。

取值范围:

UUID格式，[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}。

默认取值:

不涉及。

node_id

否

Array of strings

参数解释:

超节点下节点ID，可以从查询节点列表接口的响应中获取。

约束限制:

不涉及。

取值范围:

UUID格式，[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}。

默认取值:

不涉及。

limit

否

Integer

参数解释:

分页查询单页记录数量。

约束限制:

最大值为 100，超过将返回 400 Bad Request。

取值范围:

1~100。

默认取值:

20。

marker

否

String

参数解释:

以单页最后一条资源的id作为分页标记，base64编码。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

参数解释:

用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

scheduled_events

Array of ScheduledEventDetail objects

参数解释:

计划事件列表。

取值范围:

不涉及。

page_info

PageInfo object

参数解释:

分页信息。

取值范围:

不涉及。
表5 ScheduledEventDetail

参数

参数类型

描述

type

String

参数解释:

事件类型。

取值范围:

  • redeploy：重部署

  • system-maintenance：系统维护

  • localdisk-recovery：本地盘换盘

cluster_id

String

参数解释:

集群ID，可以从查询集群列表接口的响应中获取。

取值范围:

不涉及。

hyper_node_id

String

参数解释:

超节点ID，可以从查询超节点列表接口的响应中获取。

取值范围:

不涉及。

node_infos

Array of ScheduledEventNodeInfo objects

参数解释:

计划事件节点信息列表。

取值范围:

不涉及。

description

String

参数解释:

事件描述。

取值范围:

1~256个字符。

id

String

参数解释:

计划事件ID，可以从查询计划事件列表接口的响应中获取。

取值范围:

不涉及。

publish_time

String

参数解释:

事件发布时间。

取值范围:

格式为yyyy-MM-dd'T'HH:mm:ss.SSSXXX。例如：2026-05-22T06:30:45.123Z。

start_time

String

参数解释:

事件开始时间。

取值范围:

格式为yyyy-MM-dd'T'HH:mm:ss.SSSXXX。例如：2026-05-22T06:30:45.123Z。

finish_time

String

参数解释:

事件完成时间。

取值范围:

格式为yyyy-MM-dd'T'HH:mm:ss.SSSXXX。例如：2026-05-22T06:30:45.123Z。

status

String

参数解释:

事件状态。

取值范围:

  • inquiring：待授权

  • scheduled：待执行

  • executing：执行中

  • completed：已完成

  • failed：失败

  • canceled：已取消
表6 ScheduledEventNodeInfo

参数

参数类型

描述

node_id

String

参数解释:

节点ID，可以从查询节点列表接口的响应中获取。

取值范围:

不涉及。

execute_options

execute_options object

参数解释:

执行选项。

取值范围:

不涉及。
表7 execute_options

参数

参数类型

描述

serial_number

Array of strings

参数解释:

本地盘序列号。本地盘换盘（localdisk-recovery）类型的计划事件前提条件是有一个告警，本地盘序列号可以从该告警中获取，当计划事件类型为"localdisk-recovery"时，serial_number为必选字段。

取值范围:

不涉及。
表8 PageInfo

参数

参数类型

描述

next_marker

String

参数解释:

以单页最后一条资源标识作为分页标记，base64编码。用于请求下一页使用的分页标记。

取值范围:

不涉及。

current_count

Integer

参数解释 :

当前查询结果数量。

取值范围 :

不涉及。

请求示例

查询计划事件列表请求示例。使用场景：用户需要查看当前项目下租户可见的计划事件时，通过设置过滤条件查询满足要求的事件列表。

GET https://{endpoint}/v2/0605767a3300d5762fb7c0186d9e1779/scheduled-events?limit=10

响应示例

状态码：200

查询计划事件列表成功

ListScheduledEvents成功响应示例

{
  "scheduled_events" : [ {
    "id" : "e902820f-8969-4449-b0a2-a7292bf89e61",
    "type" : "system-maintenance",
    "cluster_id" : "124324a2-b9f3-4284-a245-15396c477aa0",
    "hyper_node_id" : "6f6d8b56-f674-447f-90e4-1cfed363adc6",
    "node_infos" : [ {
      "node_id" : "9eb280a4-3c04-48e9-885a-a8724317fbf6",
      "execute_options" : { }
    } ],
    "description" : "系统维护事件",
    "publish_time" : "2026-06-27T06:46:51.132Z",
    "start_time" : "2026-06-27T07:00:00.000Z",
    "finish_time" : "2026-06-27T08:00:00.000Z",
    "status" : "inquiring"
  } ],
  "page_info" : {
    "next_marker" : null,
    "current_count" : 1
  }
}

状态码

状态码

描述

200

查询计划事件列表成功

错误码

请参见错误码。

父主题： 计划事件

相关文档