取消Statement执行 - CancelSqlStatement

功能介绍

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

调试

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

授权信息

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

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

  授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
  DataArtsFabric:workspace:cancelStatement	Write	workspace *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	-	DataArtsFabric:workspace:list DataArtsFabric:endpoint:show
  		endpoint	-

URI

POST /v1/workspaces/{workspace_id}/sessions/{session_id}/statements/{statement_id}/cancel

请求参数

响应参数

状态码：200

状态码：400

状态码：401

状态码：404

状态码：408

状态码：500

请求示例

取消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"
}

状态码

错误码

请参见错误码。