ModifyScheduledTask - 开放搜索

描述

修改一个定时任务

方法

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

示例

请求示例

PUT /v4/openapi/app-groups/110091051/scheduled-tasks/63ff2d58-5871-11ea-974a-7cd30ad3e268

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

返回示例

正确返回

{
  "requestId": "0EDC7096-400E-4384-FFB0-52E0B4BDE63B",
  "result": {
    "id": "63ff2d58-5871-11ea-974a-7cd30ad3e268",
    "progress": 0,
    "status": 3,
    "lastRanTimestamp": null,
    "type": "wipe",
    "running": false,
    "paused": false,
    "finished": false,
    "idle": true,
    "created": 1582705462,
    "updated": 1582705462,
    "cron": "0 0 * * 1,2,3,4,5,6,7",
    "enabled": true,
    "appId": null,
    "appGroupId": "110091051",
    "ownerId": "84",
    "lastScheduledTimestamp": null,
    "forkedAppId": "",
    "appGroup": {
      "id": "110091051"
    },
    "owner": {
      "id": "84"
    },
    "filter": {
      "field": "cat_id",
      "days": 30,
      "unit": "s"
    }
  }
}

错误返回
参考：响应结构