查询计划事件列表 - ListScheduledEvents

功能介绍

查询计划事件列表信息。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v1/{project_id}/scheduled-events

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：用户项目ID。获取方法请参见获取项目ID和名称。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

表2 Query参数
参数	是否必选	参数类型	描述
workspaceId	否	String	参数解释：工作空间ID，默认值为0，取值于查询workspaces列表的接口的id字段。约束限制：系统自动生成，只能以小写字母开头，数字、中划线组成，不能以中划线结尾，且长小于63个字符。取值范围：不涉及。默认取值：不涉及。
state	否	Array of strings	参数解释：事件状态。约束限制：不涉及。取值范围：可选择值如下： inquiring: 待授权 scheduled: 待执行 executing: 执行中 completed: 执行成功 failed: 执行失败 canceled: 取消默认取值：不涉及。
type	否	Array of strings	参数解释：事件类型。约束限制：不涉及。取值范围：可选择值如下： system-maintenance：系统维护 localdisk-recovery：本地盘恢复 node_reboot：节点重启 operation-request：运维授权 node_maintenance：超节点维护 node_redeploy：超节点重部署 node_localdisk_recovery 超节点本地盘恢复默认取值：不涉及。
id	否	Array of strings	参数解释：计划事件ID，取值查询计划事件列表接口的event_id字段。支持批量筛选，批量筛选时传递多个参数，且最多支持100个。约束限制：系统自动生成，只能以小写字母开头，数字、中划线组成，不能以中划线结尾，长度小于63。取值范围：不涉及。默认取值：不涉及。
nodeName	否	String	参数解释：节点名称，取值自节点详情的metadata.name字段。约束限制：系统自动生成，只能以小写字母开头，数字、中划线组成，不能以中划线结尾，小于63个字符。取值范围：不涉及。默认取值：不涉及。
poolName	否	String	参数解释：资源池名称, lite-cluster、standard才具有，取值自资源池详情的metadata.name字段。查询指定standard cluster和lite cluster下节点的计划事件时可传递该参数。约束限制：系统自动生成，只能以小写字母开头，数字、中划线组成，不能以中划线结尾，小于63个字符。取值范围：不涉及。默认取值：不涉及。
publishStartTime	否	String	参数解释：事件发布开始时间,按照时间范围过滤。约束限制：按照ISO8601标准表示，并使用UTC +0时间，格式为yyyy-MM-ddTHH:mm:ssZ。取值范围：不涉及。默认取值：不涉及。
publishEndTime	否	String	参数解释：事件发布结束时间,按照时间范围过滤。约束限制：按照ISO8601标准表示，并使用UTC +0时间，格式为yyyy-MM-ddTHH:mm:ssZ。取值范围：不涉及。默认取值：不涉及。
offset	否	Integer	参数解释：偏移量,表示从此偏移量开始查询。约束限制：不涉及。取值范围：[0,1000000000]。默认取值：0。
limit	否	Integer	参数解释：指定每一页返回的最大条目数。约束限制：不涉及。取值范围：[1,100]。默认取值：100。

请求参数

无

响应参数

状态码：200

表3 响应Header参数
参数	参数类型	描述
X-request-id	String	This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname.

表4 响应Body参数
参数	参数类型	描述
events	Array of ScheduledEvent objects	'参数解释：计划事件列表'。
count	Integer	参数解释：计划事件总数。取值范围：不涉及。

表5 ScheduledEvent
参数	参数类型	描述
id	String	参数解释：计划事件ID，取值查询计划事件列表接口的event_id字段。系统自动生成，只能以小写字母开头，数字、中划线组成，不能以中划线结尾，长度小于63。取值范围：不涉及。
catalog	String	参数解释：事件分类。取值范围：不涉及。
isHyperNode	String	参数解释：超节点标识。取值范围：true / false
type	String	参数解释：事件类型。取值范围：可选值如下： system-maintenance：系统维护 localdisk-recovery：本地盘恢复 node_reboot：节点重启 operation-request：运维授权 node_maintenance：超节点维护 node_redeploy：超节点重部署 node_localdisk_recovery 超节点本地盘恢复
description	String	参数解释：对计划事件的描述信息。系统自动生成。取值范围：不涉及。
state	String	参数解释：事件状态。取值范围：可选择值如下： inquiring: 待授权 scheduled: 待执行 executing: 执行中 completed: 执行成功 failed: 执行失败 canceled: 取消 part-completed: 部分成功
publishTime	String	参数解释：事件发布时间。取值范围：不涉及。
startTime	String	参数解释：事件开始时间。取值范围：不涉及。
finishTime	String	参数解释：事件完成时间。取值范围：不涉及。
notBefore	String	参数解释：事件计划执行开始时间，格式为UTC时间字符串：2025-09-15T07:02:30Z。取值范围：不涉及。
probeMsg	String	参数解释：提示信息。取值范围：不涉及。
executeOptions	ExecuteOptions object	参数解释：执行选项。取值范围：不涉及。
redeployType	Array of strings	参数解释：节点重部署类型列表，标识该计划事件支持的重部署方式。取值范围：可选值如下： SOFT：表示支持重部署 HARD：表示支持强制重部署
autoRecoveryCheckTime	String	参数解释：事件系统自动授权执行时间，格式为UTC时间字符串：2025-09-15T07:02:30Z。取值范围：不涉及。
nodes	Array of NodeEvent objects	参数解释：事件关联节点信息列表。取值范围：不涉及。
instanceId	String	参数解释：节点ID。计算服务系统自动生成的实例ID，长度小于63。取值范围：不涉及。
nodeName	String	参数解释：节点名称，取值自节点详情的metadata.name字段。系统自动生成，只能以小写字母开头，数字、中划线组成，不能以中划线结尾，小于63个字符。取值范围：不涉及。
instanceType	String	参数解释：节点类型归属。取值范围可选择值如下： devserver：lite-server节点 lite-cluster lite池 standard 标准池
underLyingInstanceId	String	参数解释：超节点场景对应ECS服务器ID。计算服务系统自动生成的实例ID，长度小于63。取值范围：超节点涉及, snt9b 不涉及。
flavorSupportRedeploy	Boolean	参数解释：规格是否支持重部署。取值范围：true/false。
poolName	String	参数解释：资源池名称, lite-cluster、standard才具有，取值自资源池详情的metadata.name字段。系统自动生成，只能以小写字母开头，数字、中划线组成，不能以中划线结尾，小于63个字符。取值范围：不涉及。
poolDisplayName	String	参数解释：资源池对外显示的名称, lite-cluster、standard才具有，取值自资源池详情的metadata.labels字段。只能以小写字母开头，数字、中划线组成，不能以中划线结尾，且长度为[36-63]个字符。取值范围：不涉及。
jobProgress	String	参数解释：重部署执行的实时进度信息，系统自动生成。取值范围：不涉及。

表6 ExecuteOptions
参数	参数类型	描述
serialNumber	String	参数解释：序列号。

表7 NodeEvent
参数	参数类型	描述
eventId	String	参数解释：Iaas计划事件Id。取值范围：不涉及。
isFaultNode	Boolean	参数解释：是否故障节点。取值范围：不涉及。
nodeName	String	参数解释：节点名称。取值范围：不涉及。
instanceId	String	参数解释：节点ID。取值范围：不涉及。
instanceType	String	参数解释：实例类型。取值范围：不涉及。
underLyingInstanceId	String	参数解释：底层实例Id。取值范围：不涉及。
flavorSupportRedeploy	Boolean	参数解释：节点规格是否支持重部署。取值范围：不涉及。
poolName	String	参数解释：资源池名称。取值范围：不涉及。
poolDisplayName	String	参数解释：资源池显示名称。取值范围：不涉及。
state	String	参数解释：Iaas计划事件状态。取值范围：不涉及。
publishTime	String	参数解释：Iaas事件发布时间。取值范围：不涉及。
startTime	String	参数解释：Iaas事件开始时间。取值范围：不涉及。
finishTime	String	参数解释：Iaas事件完成时间。取值范围：不涉及。
jobProgress	String	参数解释：重部署进度。取值范围：不涉及。

状态码：400

表8 响应Header参数
参数	参数类型	描述
X-request-id	String	This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname.

表9 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

请求示例

无

响应示例

状态码：200

{
  "events" : [ {
    "id" : "ma-event-e2df806e",
    "catalog" : "system-maintenance",
    "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
}

状态码

状态码	描述
200	计划事件列表响应。
400	Error response

错误码

请参见错误码。

父主题： 计划事件

上一篇：计划事件授权 - AcceptScheduledEvent

下一篇：任务管理