文档首页/ MapReduce服务 MRS/ API参考/ API V2/ SQL接口/ 取消SQL执行任务
更新时间：2024-08-07 GMT+08:00
查看PDF
分享

取消SQL执行任务

功能介绍

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

接口约束

无

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v2/{project_id}/clusters/{cluster_id}/sql-execution/{sql_id}/cancel
表1 URI参数说明

名称

是否必选

参数类型

说明

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

只能由英文字母和数字组成，且长度为[1-64]个字符。

默认取值：

不涉及

cluster_id

是

String

参数解释：

集群ID。如果指定集群ID，则获取该集群做过补丁更新的最新版本元数据。获取方法，请参见获取集群ID。

约束限制：

不涉及

取值范围：

只能由英文字母、数字以及“_”和“-”组成，且长度为[1-64]个字符。

默认取值：

不涉及

sql_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求参数

无

响应参数

状态码： 200

表2 响应参数说明

参数名

参数类型

说明

message

String

参数解释：

错误信息。

取值范围：

不涉及

status

String

参数解释：

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

取值范围：

  • SUCCEED：成功
  • FAILED：失败

状态码： 400

表3 响应Body参数

参数

参数类型

描述

message

String

参数解释：

错误信息。

取值范围：

不涉及

status

String

参数解释：

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

取值范围：

  • SUCCEED：成功
  • FAILED：失败

请求示例

取消SQL执行任务请求示例

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

响应示例

状态码： 200

取消SQL执行任务成功

{
  "status" : "SUCCEED"
}

状态码： 400

取消SQL执行任务失败

{
  "status" : "FAILED",
  "message" : "Cancel sql error"
}

状态码

状态码请参见状态码。

错误码

请参见错误码。

父主题： SQL接口