文档首页 > > API参考> 历史API> SQL作业相关API(废弃)>

取消作业(废弃)

取消作业(废弃)

分享
更新时间:2020/12/30 GMT+08:00

功能介绍

该API用于取消已经提交的作业,若作业已经执行结束或失败则无法取消。

本章节介绍的API已过时,推荐使用取消作业(推荐)介绍的API。

URI

  • URI格式:

    DELETE /v1.0/{project_id}/queues/{queue_name}/jobs/{job_id}

  • 参数说明
    表1 URI 参数

    名称

    是否必选

    说明

    project_id

    项目编号,用于资源隔离。获取方式请参考获取项目ID

    queue_name

    待取消作业所在的队列名称。

    job_id

    作业ID。

请求消息

无请求参数。

响应消息

表2 响应参数

参数

是否必选

参数类型

说明

is_success

Boolean

执行请求是否成功。“true”表示请求执行成功。

message

String

系统提示信息,执行成功时,信息可能为空。

示例

  • 请求样例:
    None
  • 成功响应样例:
    {
      "is_success": true,
      "message": ""
    }

    调用API出错后,将不会返回上述结果,而是返回错误码和错误信息,详细介绍请参见错误码

分享:

    相关文档

    相关产品