更新时间:2025-11-19 GMT+08:00

查询计划事件列表

功能介绍

查询计划事件列表信息。

调试

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

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: 取消

默认取值:不涉及。

请求参数

响应参数

状态码: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

参数解释:计划事件列表

表5 ScheduledEvent

参数

参数类型

描述

id

String

参数解释:计划事件ID,取值查询计划事件列表接口的event_id字段。 系统自动生成,只能以小写字母开头,数字、中划线组成,不能以中划线结尾,长度小于63。

取值范围:不涉及。

catalog

String

参数解释:事件分类。

取值范围:可选值如下: - hardware:硬件维修。 - software:软件维修。

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: 取消

instanceType

String

参数解释:节点类型归属。

取值范围可选择值如下:

  • devserver:lite-server节点

  • lite-cluster lite池

  • standard 标准池

instanceId

String

参数解释:服务器ID。计算服务系统自动生成的实例ID,长度小于63。

取值范围:不涉及。

nodeName

String

参数解释:节点名称,取值自节点详情的metadata.name字段。系统自动生成,只能以小写字母开头,数字、中划线组成,不能以中划线结尾,小于63个字符。

取值范围:不涉及。

poolName

String

参数解释:资源池名称, lite-cluster、standard才具有,取值自资源池详情的metadata.name字段。系统自动生成,只能以小写字母开头,数字、中划线组成,不能以中划线结尾,小于63个字符。

取值范围:不涉及。

poolDisplayName

String

参数解释:资源池对外显示的名称, lite-cluster、standard才具有,取值自资源池详情的metadata.name字段。只能以小写字母开头,数字、中划线组成,不能以中划线结尾,且长度为[36-63]个字符。

取值范围:不涉及。

publishTime

String

参数解释:事件发布时间。

约束限制:格式为UTC时间字符串:2025-09-15T07:02:30Z。

取值范围:不涉及。

默认取值:不涉及。

startTime

String

参数解释:事件开始时间。

约束限制:格式为UTC时间字符串:2025-09-15T07:02:30Z。

取值范围:不涉及。

默认取值:不涉及。

finishTime

String

参数解释:事件完成时间。

约束限制:格式为UTC时间字符串:2025-09-15T07:02:30Z。

取值范围:不涉及。

默认取值:不涉及。

notBefore

String

参数解释:事件计划执行开始时间,格式为UTC时间字符串:2025-09-15T07:02:30Z。

约束限制:大于当前时间。

取值范围:不涉及。

默认取值:不填表示立即执行。

probeMsg

String

参数解释:提示信息。

约束限制:系统自动生成,只能以小写字母开头,数字、中划线组成,不能以中划线结尾,长度小于63字符。

取值范围:不涉及。

默认取值:不涉及。

redeployType

Array of strings

参数解释:节点的重部署类型。

约束限制:不涉及。

取值范围:可选值如下:- HARD:表示支持强制重部署, - SOFT:表示支持重部署

默认取值:不涉及。

状态码:400

表6 响应Header参数

参数

参数类型

描述

X-request-id

String

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

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

响应示例

状态码

状态码

描述

200

计划事件列表响应。

400

Error response

错误码

请参见错误码