更新时间:2025-12-24 GMT+08:00

修改指定的定时任务

功能介绍

修改指定的定时任务。

URI

PUT /v2/{project_id}/instances/{instance_id}/scheduled-tasks/{task_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,获取方式请参见获取项目ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

instance_id

是

String

参数解释:

实例ID。获取方法如下:调用“查询所有实例列表”接口,从响应体中获取实例ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

task_id

是

String

参数解释:

定时任务ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

execute_at

否

String

参数解释:

修改定时任务的执行时间。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

status

否

String

参数解释:

修改定时任务状态。

约束限制:

不涉及。

取值范围:

  • CANCELLED:定时任务被取消。

  • null:定时任务待执行。

默认取值:

不涉及。

请求参数

无

响应参数

状态码:204

修改定时任务成功。

无

请求示例

  • 将指定定时任务的执行时间修改为20240101000000。

    PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/scheduled-tasks/{task_id}?execute_at=20240101000000
  • 取消指定的定时任务。

    PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/scheduled-tasks/{task_id}?status=CANCELLED

响应示例

无

状态码

状态码

描述

204

修改定时任务成功。

错误码

请参见错误码。