全部产品
云市场
云游戏

ModifyScheduledTask

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

描述

修改一个定时任务

方法

PUT

URI

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

请求参数

路径参数

字段 类型 是否必要 示例值 描述
appGroupIdentity String “my_app_group_name” 应用名称
taskId String “2f12c585-5873-11ea-974a-7cd30ad3e268” 任务ID

请求体

字段 类型 是否必要 示例值 描述
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” 过期字段

返回参数

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

示例

请求示例

  1. PUT /v4/openapi/app-groups/110091051/scheduled-tasks/63ff2d58-5871-11ea-974a-7cd30ad3e268
  1. {
  2. "cron": "0 0 * * 1,2,3,4,5,6,7",
  3. "enabled": true,
  4. "filter": {
  5. "field": "cat_id",
  6. "days": 30,
  7. "unit": "s"
  8. }
  9. }

返回示例

正确返回

  1. {
  2. "requestId": "0EDC7096-400E-4384-FFB0-52E0B4BDE63B",
  3. "result": {
  4. "id": "63ff2d58-5871-11ea-974a-7cd30ad3e268",
  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": 1582705462,
  14. "updated": 1582705462,
  15. "cron": "0 0 * * 1,2,3,4,5,6,7",
  16. "enabled": true,
  17. "appId": null,
  18. "appGroupId": "110091051",
  19. "ownerId": "84",
  20. "lastScheduledTimestamp": null,
  21. "forkedAppId": "",
  22. "appGroup": {
  23. "id": "110091051"
  24. },
  25. "owner": {
  26. "id": "84"
  27. },
  28. "filter": {
  29. "field": "cat_id",
  30. "days": 30,
  31. "unit": "s"
  32. }
  33. }
  34. }


错误返回
参考:响应结构