文档首页/ 数智融合计算服务 DataArtsFabric/ API参考/ API/ SQL业务接口/ 取消Statement执行
更新时间：2025-06-12 GMT+08:00
查看PDF
分享

取消Statement执行

功能介绍

取消SQL语句执行。用户可通过该接口取消SQL语句执行，输入为端点id、SQL Session id、语句id，返回操作结果。此接口为同步接口，无配套使用接口和特殊场景。

调试

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

URI

POST https://localhost.com/v1/workspaces/{workspace_id}/sessions/{session_id}/statements/{statement_id}/cancel

表1 路径参数

参数

是否必选

参数类型

描述

workspace_id

是

String

  • 参数解释：工作空间的ID。

  • 约束限制：不涉及。

  • 取值范围：长度为[1,36]的字母、数字、中划线(-)的组合。

  • 默认取值：不涉及。

session_id

是

String

  • 参数解释：SessionId的ID。

  • 约束限制：不涉及。

  • 取值范围：长度为[1,36]的字母、数字、中划线(-)的组合。

  • 默认取值：不涉及。

statement_id

是

String

  • 参数解释：statement id。

  • 约束限制：不涉及。

  • 取值范围：长度为[1,64]的字母、数字、中划线(-)和下划线(_)的组合。

  • 默认取值：不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

  • 参数解释：租户token。

  • 约束限制：不涉及。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

-

AnyType

空响应。

状态码：400

表4 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释：错误码。

  • 约束限制：不涉及。

  • 取值范围：长度[8,36]。

  • 默认取值：不涉及。

error_msg

String

  • 参数解释：错误描述。

  • 约束限制：不涉及。

  • 取值范围：长度[2,4096]。

  • 默认取值：不涉及。

solution_msg

String

  • 参数解释：解决方案描述。

  • 约束限制：不涉及。

  • 取值范围：长度[2,4096]。

  • 默认取值：不涉及。

状态码：401

表5 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释：错误码。

  • 约束限制：不涉及。

  • 取值范围：长度[8,36]。

  • 默认取值：不涉及。

error_msg

String

  • 参数解释：错误描述。

  • 约束限制：不涉及。

  • 取值范围：长度[2,4096]。

  • 默认取值：不涉及。

solution_msg

String

  • 参数解释：解决方案描述。

  • 约束限制：不涉及。

  • 取值范围：长度[2,4096]。

  • 默认取值：不涉及。

状态码：404

表6 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释：错误码。

  • 约束限制：不涉及。

  • 取值范围：长度[8,36]。

  • 默认取值：不涉及。

error_msg

String

  • 参数解释：错误描述。

  • 约束限制：不涉及。

  • 取值范围：长度[2,4096]。

  • 默认取值：不涉及。

solution_msg

String

  • 参数解释：解决方案描述。

  • 约束限制：不涉及。

  • 取值范围：长度[2,4096]。

  • 默认取值：不涉及。

状态码：408

表7 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释：错误码。

  • 约束限制：不涉及。

  • 取值范围：长度[8,36]。

  • 默认取值：不涉及。

error_msg

String

  • 参数解释：错误描述。

  • 约束限制：不涉及。

  • 取值范围：长度[2,4096]。

  • 默认取值：不涉及。

solution_msg

String

  • 参数解释：解决方案描述。

  • 约束限制：不涉及。

  • 取值范围：长度[2,4096]。

  • 默认取值：不涉及。

状态码：500

表8 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释：错误码。

  • 约束限制：不涉及。

  • 取值范围：长度[8,36]。

  • 默认取值：不涉及。

error_msg

String

  • 参数解释：错误描述。

  • 约束限制：不涉及。

  • 取值范围：长度[2,4096]。

  • 默认取值：不涉及。

solution_msg

String

  • 参数解释：解决方案描述。

  • 约束限制：不涉及。

  • 取值范围：长度[2,4096]。

  • 默认取值：不涉及。

请求示例

取消SQL语句执行。用户可通过该接口取消SQL语句执行，输入为端点id、SQL Session id、语句id，返回操作结果。此接口为同步接口，无配套使用接口和特殊场景。

POST https://endpoint/v1/workspaces/{workspace_id}/sessions/{session_id}/cancel

{ }

响应示例

状态码：400

BadRequest

{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}

状态码：401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码：403

Forbidden

{
  "error" : {
    "code" : "403",
    "message" : "X-Auth-Token is invalid in the request",
    "title" : "Forbidden"
  },
  "error_code" : 403,
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}

状态码：404

NotFound

{
  "error_code" : "common.01000001",
  "error_msg" : "response status exception, code: 404"
}

状态码：408

Request Time-out

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

状态码：500

InternalServerError

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error"
}

状态码

状态码

描述

200

空响应。

400

BadRequest

401

Unauthorized

403

Forbidden

404

NotFound

408

Request Time-out

500

InternalServerError

错误码

请参见错误码。

父主题： SQL业务接口

相关文档