CreateScheduledTask_定时任务_管控API参考_开发指南

描述

创建一个 opensearch 应用的定时任务

方法

POST

URI

/v4/openapi/app-groups/[appGroupIdentity]/scheduled-tasks

请求参数

路径参数

字段	类型	是否必要	示例值	描述
appGroupIdentity	String	是	“my_app_group_name”	应用名称

请求体

字段	类型	是否必要	示例值	描述
type	String	是	“wipe”	定时任务类型 - wipe 数据清理 - fork 索引重建 - check-status 检查应用状态 - index 索引重建 - app
cron	String	是	“10 20 1,2,3,4,5”	定时配置参考：ScheduledTask 定时规则
enabled	Boolean	是	true	是否开启定时任务
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）

返回参数

字段	类型	描述
requestId	String	请求ID
result	Object	定时任务信息参考：ScheduledTask

示例

请求示例

POST /v4/openapi/app-groups/130091942/scheduled-tasks

{
  "type": "wipe",
  "cron": "0 0 * * 1,2,3,4,5,6,7",
  "enabled": true,
  "filter": {
    "field": "title",
    "days": 30,
    "unit": "s"
  }
}

返回示例

正确返回

{
    "requestId": "0BECF34E-125A-D35F-1E5D-ABB66B11FAB8",
    "result": {
        "id": "cfd5ebe9-bcdd-11ea-a58d-98039b07e4ec",
        "progress": 0,
        "status": 3,
        "lastRanTimestamp": null,
        "type": "wipe",
        "running": false,
        "paused": false,
        "finished": false,
        "idle": true,
        "created": 1593747144,
        "updated": 1593747144,
        "cron": "0 0 * * 1,2,3,4,5,6,7",
        "enabled": true,
        "lastScheduledTimestamp": null,
        "forkedAppId": "",
        "filter": {
            "field": "title",
            "days": 30,
            "unit": "s"
        }
    }
}

错误返回
参考：响应结构