更新时间:2022-08-12 GMT+08:00

取消SQL执行任务

功能介绍

在MRS集群中取消一条SQL的执行任务。

URI

  • URI格式

    POST /v2/{project_id}/clusters/{cluster_id}/sql-execution/{sql_id}/cancel

  • 参数说明
    表1 URI参数说明

    名称

    是否必选

    说明

    project_id

    项目编号。获取方法,请参见获取项目ID

    cluster_id

    集群ID。获取方法,请参见获取集群ID

    sql_id

    SQL的执行ID,即提交SQL语句返回结果中的sql_id。

请求消息

请求参数

无。

响应参数

表2 响应参数说明

参数名

参数类型

说明

status

String

取消SQL的执行结果。

  • SUCCEED:成功
  • FAILED:失败
说明:

默认返回SUCCEED,对于已经结束的任务也会返回SUCCEED,只有取消正在运行的SQL时没成功才会FAILED。

message

String

错误信息。

示例

  • 请求示例

    无。

  • 响应示例
    • 成功示例
      {
          "status":"SUCCEED"
       }
    • 失败示例
      { 
          "status":"FAILED",
          "message":"Cancel sql error"
       }

状态码

状态码请参见状态码