修改一个定时任务

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

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

请求参数

名称 类型 位置 是否必选 示例值 描述
appGroupIdentity String Path “my_app_group_name”

应用名称

taskId String Path “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 D77D0DAF-790D-F5F5-A9C0-133738165014

请求ID

result Map (Array|Object)

定时任务信息

示例

请求示例

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"
  }
}

正常返回示例

XML格式

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

JSON格式

{
    "requestId": "0EDC7096-400E-4384-FFB0-52E0B4BDE63B",
    "result": {
        "id": "63ff2d58-5871-11ea-974a-7cd30ad3e268",
        "progress": 0,
        "status": 3,
        "lastRanTimestamp": "",
        "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": "",
        "appGroupId": 110091051,
        "ownerId": 84,
        "lastScheduledTimestamp": "",
        "forkedAppId": "",
        "appGroup": {
            "id": 110091051
        },
        "owner": {
            "id": 84
        },
        "filter": {
            "field": "cat_id",
            "days": 30,
            "unit": "s"
        }
    }
}

错误码

访问错误中心查看更多错误码。