文档中心

云数据库 veDB MySQL 版

计划内事件

DescribeScheduleEvents - 查询计划内事件

DescribeScheduleEvents - 查询计划内事件

调用 DescribeScheduleEvents 接口查看当前账号下的计划内事件。

请求类型

同步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
Limit	Integer	否	10	每页记录数。最小值为 1，最大值不超过 500。默认值为 10。
Offset	Integer	否	0	当前页查询偏移量，取值最小为 0。默认值为 0。
EventId	String	否	4nbx88ea9dxa****	事件 ID。
InstanceId	String	否	vedbm-ca12cbqv****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有实例的基本信息，包括实例 ID。
BeginTime	String	否	2024-03-13T03:07:19Z	事件开始执行时间，格式：YYYY-MM-DDTHH:MM:SSZ（UTC 时间）。
EndTime	String	否	2024-03-13T03:07:19Z	事件执行结束时间，格式：YYYY-MM-DDTHH:MM:SSZ（UTC 时间）。
Status	Array of String	否	pending	事件状态。取值： pending：待执行。 executing：执行中。 failure：执行失败。 finish：已完成。 cancel：已取消。
EventKind	Array of String	否	ModifyDBInstanceSpec	事件类型。取值： ModifyDBInstanceParameters：修改参数。 ModifyDBInstanceSpec：配置变更。 UpgradeInstance：版本升级。 RestartDBInstance：重启实例。
ProjectName	String	否	default	事件对应实例所属的项目名称。

返回参数

参数	类型	示例值	描述
ScheduleTasksInfo	Array of ScheduleTasksInfoObject	请参见返回示例。	事件详情信息。
Total	Integer	2	事件总数。

ScheduleTasksInfoObject

参数	类型	示例值	描述
AccountID	Long	210006****	账号 ID。
BeginTime	String	2024-03-13T03:07:19Z	事件开始执行时间（UTC 时间）。
EndTime	String	2024-03-13T03:07:19Z	事件执行结束时间（UTC 时间）。
EventId	String	4nbx88ea9dxa****	事件 ID。
EventKind	String	ModifyDBInstanceSpec	事件类型。取值： ModifyDBInstanceParameters：修改参数。 ModifyDBInstanceSpec：配置变更。 UpgradeInstance：版本升级。 RestartDBInstance：重启实例。
InstanceID	String	vedbm-ca12cbqv****	实例 ID。
InstanceName	String	test	实例名称。
Message	String	-	事件详情。当计划内事件执行失败时，该参数会返回事件的错误详情。
PlannedStartTime	String	2024-03-13T03:07:19Z	计划执行时间（UTC 时间）。
Status	String	pending	事件状态。取值： pending：待执行。 executing：执行中。 failure：执行失败。 finish：已完成。 cancel：已取消。
RequestId	String	56bffd64-dd72-48f7-b370-c03f360d****	请求 ID。
ScheduleType	String	MaintainTime	计划内事件执行方式，取值： MaintainTime：在可维护时间窗口执行。 SpecifiedTime：指定时间执行，例如将事件执行时间修改为立即执行。
ProjectName	String	default	实例所属项目。

示例

请求示例

返回示例

错误码

更多详情，请参见错误码。

最近更新时间：2026.07.07 17:23:22

这个页面对您有帮助吗？

有用

有用

无用

无用