全部产品
云市场
云游戏

CreateScheduledTask

更新时间:2020-07-17 18:02:07

描述

创建一个 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

示例

请求示例

  1. POST /v4/openapi/app-groups/130091942/scheduled-tasks
  1. {
  2. "type": "wipe",
  3. "cron": "0 0 * * 1,2,3,4,5,6,7",
  4. "enabled": true,
  5. "filter": {
  6. "field": "title",
  7. "days": 30,
  8. "unit": "s"
  9. }
  10. }

返回示例

正确返回

  1. {
  2. "requestId": "0BECF34E-125A-D35F-1E5D-ABB66B11FAB8",
  3. "result": {
  4. "id": "cfd5ebe9-bcdd-11ea-a58d-98039b07e4ec",
  5. "progress": 0,
  6. "status": 3,
  7. "lastRanTimestamp": null,
  8. "type": "wipe",
  9. "running": false,
  10. "paused": false,
  11. "finished": false,
  12. "idle": true,
  13. "created": 1593747144,
  14. "updated": 1593747144,
  15. "cron": "0 0 * * 1,2,3,4,5,6,7",
  16. "enabled": true,
  17. "lastScheduledTimestamp": null,
  18. "forkedAppId": "",
  19. "filter": {
  20. "field": "title",
  21. "days": 30,
  22. "unit": "s"
  23. }
  24. }
  25. }


错误返回
参考:响应结构