文档首页/ 云数据库 RDS/ API参考/ API v3（推荐）/ 事件管理/ 操作EG事件中心通知的事件 - BatchExecuteEvents
更新时间：2025-12-31 GMT+08:00
查看PDF
分享

操作EG事件中心通知的事件 - BatchExecuteEvents

功能介绍

操作EG事件中心通知的事件。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

rds:event:modify

write

-

-

-

-

URI

  • URI格式

    POST /v3/{project_id}/schedule-events

  • 参数说明
    表1 路径参数

    名称

    是否必选

    参数类型

    描述

    project_id

    是

    String

    参数解释：

    租户在某一Region下的项目ID。

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

    约束限制：

    不涉及。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

请求参数

表2 参数说明

名称

是否必选

参数类型

描述

event_instances

是

object

参数解释：

事件列表。详见表3。

约束限制：

不涉及。

operation_type

是

String

参数解释：

事件操作类型。

约束限制：

不涉及。

取值范围：

  • cancel：取消。
  • execute：执行。
  • reservation：预约。

默认取值：

不涉及。

event_schedule_window

否

object

参数解释：

事件调度窗口。详见表4。

约束限制：

operation_type参数值为reservation时，event_schedule_window参数必传。
表3 event_instances字段说明

名称

是否必选

参数类型

描述

event_id

是

String

参数解释：

事件ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表4 event_schedule_window字段说明

名称

是否必选

参数类型

描述

planned_day

是

String

参数解释：

计划执行日期。格式：yyyy-MM-dd

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

start_time

否

String

参数解释：

计划执行窗口开始时间。格式：hh:mm

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

end_time

否

String

参数解释：

计划执行窗口结束时间。格式：hh:mm

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求示例

查询事件列表。

POST https://{Endpoint}/v3/54623db08b174c858ba779d2aa7923a3/schedule-events

{
  "event_instances": [
    {
      "instance_id": "a2c16e6bfd3d4d28ba41091b95488618in01",
      "event_id": "131375c299d54da989589048900e568fev01"
    }
  ],
  "event_schedule_window": {
    "planned_day": "2025-11-13",
    "start_time": "06:00",
    "end_time": "10:00"
  },
  "operation_type": "reservation"
}

响应参数

  • 正常响应要素说明
    表5 响应Body参数

    名称

    参数类型

    描述

    results

    Array of objects

    参数解释：

    事件操作响应结果，详见表6。
    表6 results字段说明

    名称

    参数类型

    描述

    id

    String

    参数解释：

    事件ID。

    取值范围：

    不涉及。

    instance_id

    String

    参数解释：

    实例ID。

    取值范围：

    不涉及。

    job_id

    String

    参数解释：

    任务ID。

    取值范围：

    不涉及。

    error_code

    String

    参数解释：

    错误码。

    取值范围：

    不涉及。

    error_msg

    String

    参数解释：

    错误信息。

    取值范围：

    不涉及。

    success

    Boolean

    参数解释：

    是否成功。

    取值范围：

    • true：成功。
    • false：失败。
  • 正常响应样例

    无。

  • 异常响应

    请参见异常请求结果。

状态码

错误码

请参见错误码。

父主题： 事件管理

相关文档