文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ 任务中心/ 取消定时任务- CancelScheduleTask
更新时间：2025-10-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

取消定时任务 - CancelScheduleTask

功能介绍

取消定时任务。

调用方法

请参见如何调用API。

授权信息

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

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:task:delete

    Write

    -

    -

    gaussdb:instance:delete

    -

URI

DELETE /v3/{project_id}/scheduled-jobs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us

  • zh-cn

默认取值：

en-us。
表3 请求Body参数

参数

是否必选

参数类型

描述

job_ids

是

Array of strings

参数解释：

待取消任务ID列表。

约束限制：

不涉及。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

job_ids

Array of strings

参数解释：

任务ID，表示成功取消定时调度任务的ID列表。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

取消定时任务。

DELETE https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/scheduled-jobs
{
  "job_ids" : [ "56d3c1138dcf4f1da73b0170700c78d0" ]
}

响应示例

状态码： 200

Success.

{
  "job_ids" : [ "56d3c1138dcf4f1da73b0170700c78d0" ]
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 任务中心