文档首页/ 云数据库 TaurusDB/ API参考/ API/ 事件管理/ 操作事件 - SetInstanceScheduleEvents
更新时间：2026-08-17 GMT+08:00
在线调试
CLI示例
查看PDF
分享

操作事件 - SetInstanceScheduleEvents

功能介绍

对事件进行授权立即执行、授权取消执行或者授权预约执行等操作。

调用方法

请参见如何调用API。

授权信息

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

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:event:operateScheduleEvents

    Permission_management

    -

    -

    gaussdb:event:operateScheduleEvents

    -

URI

POST /v3/{project_id}/schedule-events

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

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

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us：英文。

  • zh-cn：中文。

默认取值：

en-us。

Content-Type

是

String

参数解释：

内容类型。

约束限制：

不涉及。

取值范围：

application/json。

默认取值：

application/json。
表3 请求Body参数

参数

是否必选

参数类型

描述

operation_type

是

String

参数解释：

事件操作类型。

约束限制：

不涉及。

取值范围：

  • execute：授权立即执行。

  • cancel：授权取消执行。

  • reservation：授权预约执行。

默认取值：

不涉及。

event_instances

是

Array of EventInstances objects

参数解释：

事件信息。

约束限制：

批量事件个数不得超过20个。

event_schedule_window

否

Object

参数解释：

事件执行窗口。

约束限制：

当operation_type为reservation时，该字段必传。
表4 EventInstances

参数

是否必选

参数类型

描述

event_id

是

String

参数解释：

事件ID。

获取方法请参见获取事件列表。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，前面为UUID，后缀为ev07，长度为36个字符。

默认取值：

不涉及。
表5 EventScheduleWindow

参数

是否必选

参数类型

描述

planned_day

是

String

参数解释：

执行日期。

约束限制：

格式为“yyyy-mm-dd”。

取值范围：

大于或等于当前日期。

默认取值：

不涉及。

start_time

否

String

参数解释：

事件执行窗口开始时间。

约束限制：

格式为 “hh:mm”。当end_time有值时，该字段必传。

取值范围：

不涉及。

默认取值：

“01:00”。

end_time

否

String

参数解释：

事件执行窗口结束时间。

约束限制：

格式为 "hh:mm"。当start_time有值时，该字段必传。

取值范围：

不涉及。

默认取值：

“03:00”。

响应参数

状态码：200

表6 响应Body参数

参数

参数类型

描述

results

Array of EventJobResult objects

参数解释：

设置事件执行策略响应结果。
表7 EventJobResult

参数

参数类型

描述

event_id

String

参数解释：

事件ID。

取值范围：

只能由英文字母、数字组成，前面为UUID，后缀为ev07，长度为36个字符。

instance_id

String

参数解释：

实例ID。

取值范围：

只能由英文字母、数字组成，前面为UUID，后缀为in07，长度为36个字符。

job_id

String

参数解释：

创建数据同步的任务ID。

取值范围：

不涉及。

success

Boolean

参数解释：

是否下发成功。

取值范围：

  • true：下发成功。

  • false：下发失败。

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误消息。

取值范围：

不涉及。

状态码：400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码：500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

  • 执行事件。

    POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/schedule-events

{
  "operation_type" : "execute",
  "event_instances" : [ {
    "event_id" : "18855d0aa0c14685998e727a70d2760cev07"
  } ]
}

  • 取消事件。

    POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/schedule-events

{
  "operation_type" : "cancel",
  "event_instances" : [ {
    "event_id" : "18855d0aa0c14685998e727a70d2760cev07"
  } ]
}

  • 预约执行。

    POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/schedule-events

{
  "operation_type" : "reservation",
  "event_instances" : [ {
    "event_id" : "18855d0aa0c14685998e727a70d2760cev07"
  } ],
  "event_schedule_window" : {
    "planned_day" : "2025-12-17",
    "start_time" : "01:00",
    "end_time" : "02:00"
  }
}

响应示例

状态码：200

Success.

{
  "results" : [ {
    "event_id" : "18855d0aa0c14685998e727a70d2760cev07",
    "instance_id" : "5437da4b09c9450d9a4b87432bbf1336in07",
    "job_id" : "2f092208-43b4-467f-b317-11001e5667ea",
    "success" : true,
    "error_code" : null,
    "error_msg" : null
  } ]
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 事件管理

相关文档