文档首页/ 分布式消息服务RabbitMQ版/ API参考/ API V2(推荐)/ 后台任务管理/ 修改定时任务管理中的指定记录 - UpdateScheduledTask
更新时间:2025-11-24 GMT+08:00

修改定时任务管理中的指定记录 - UpdateScheduledTask

功能介绍

修改定时任务管理中的指定记录

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

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。

默认取值

不涉及。

请求参数

响应参数

状态码:204

修改定时任务成功

请求示例

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

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

    /v2/{project_id}/instances/{instance_id}/scheduled-tasks/{task_id}?status=CANCELLED

响应示例

状态码

状态码

描述

204

修改定时任务成功

错误码

请参见错误码