文档首页/ 云数据库 GeminiDB/ API参考/ API v3(推荐)/ 任务管理/ 取消定时任务 - CancelingaScheduledTask
更新时间:2025-11-27 GMT+08:00

取消定时任务 - CancelingaScheduledTask

功能介绍

根据任务ID取消定时任务。

接口约束

该接口支持如下数据库实例。

  • GeminiDB Influx
  • GeminiDB Redis
  • GeminiDB Mongo
  • GeminiDB Cassandra

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    gaussdbfornosql:instance:cancelScheduleJob

    write

    -

    -

    nosql:instance:cancelScheduleJob

    -

URI

DELETE /v3/{project_id}/scheduled-jobs/{job_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

用户在某一region下的project Id。

job_id

String

任务ID,取值为定时任务列表返回job_id字段。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户认证Token。

响应参数

状态码: 204

无响应参数。

请求示例

取消定时任务。

DELETE https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/scheduled-jobs/56d3c1138dcf4f1da73b0170700c78d0

响应示例

无。

状态码

请参见状态码

错误码

请参见错误码