文档首页> 云数据库 GaussDB(for MySQL)> API参考> API（推荐）> 任务中心> 取消定时任务
更新时间：2023-10-23 GMT+08:00
在线调试
CLI示例
查看PDF

取消定时任务

功能介绍

取消定时任务。

URI

DELETE /v3/{project_id}/scheduled-jobs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

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

X-Language

否

String

请求语言类型。默认en-us。

取值范围：

  • en-us
  • zh-cn
表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" ]
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 任务中心