创建一个 OpenSearch 应用的定时任务。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| opensearch:CreateScheduledTask |
|
| 无 |
请求语法
POST /v4/openapi/app-groups/{appGroupIdentity}/scheduled-tasks HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| appGroupIdentity | string | 是 | 应用名称 | my_app_group_name |
| body | ScheduledTask | 否 | 请求体 |
请求体
| 字段 | 类型 | 是否必要 | 示例值 | 描述 |
|---|---|---|---|---|
| type | String | 是 | "wipe" | 定时任务类型 - wipe 数据清理 - fork 导入数据加索引重建 - reindex 索引重建 - clear 清空数据 |
| cron | String | 是 | "10 20 * * 1,2,3,4,5" | 定时配置 参考：ScheduledTask 定时规则 |
| enabled | Boolean | 是 | true | 是否开启定时任务 |
| appStrategy | String | 否 | delete-idle | 创建新版本的策略 - delete-idle 已有两个版本，先删除非在线版本，再创建新版本 - need-slot 只有一个版本，直接创建新版本 |
| filter | Object | 否 | 数据清理条件 | |
| filter.days | Integer | 是 | 7 | 过期天数 获取范围：[7-180] |
| filter.unit | String | 是 | "s" | 过期时间单位 - s 秒 - ms 毫秒 |
| filter.field | String | 否 | "cate_id" | 过期字段 |
| runNow | Boolean | 否 | false | 是否立即执行（默认：false） |
| permanent | Boolean | 否 | true | 是否持久化（默认：true） |
返回参数
示例
正常返回示例
JSON格式
{
"result": {},
"requestId": "ABCDEFGH"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-05-24 | OpenAPI 入参发生变更 | 查看变更详情 |