Canceling a SQL Execution Task

This API is used to cancel the execution task of a SQL statement in an MRS cluster.

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Explanation Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints N/A Value range The value must consist of 1 to 64 characters. Only letters and digits are allowed. Default value N/A
cluster_id	Yes	String	Explanation Cluster ID. If this parameter is specified, the latest metadata of the cluster that has been patched will be obtained. For details on how to obtain the cluster ID, see Obtaining a Cluster ID. Constraints N/A Value range The value can contain 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-). Default value N/A
sql_id	Yes	String	Explanation The execution ID of a SQL statement, that is, sql_id in the return result in Submitting a SQL Statement. Constraints N/A Value range N/A Default value N/A

None

Status code: 200

**Table 2** Response parameters
Parameter	Type	Description
message	String	Explanation Error message Value range N/A
status	String	Explanation The result of canceling the execution of the SQL statement. By default, SUCCEED is returned. SUCCEED is also returned when the task is completed. Only when the running SQL statement fails to be canceled, FAILED is returned. Value range SUCCEED FAILED

Status code: 400

**Table 3** Response body parameter
Parameter	Type	Description
message	String	Explanation Error message Value range N/A
status	String	Explanation The result of canceling the execution of the SQL statement. By default, SUCCEED is returned. SUCCEED is also returned when the task is completed. Only when the running SQL statement fails to be canceled, FAILED is returned. Value range SUCCEED FAILED

Cancel a SQL execution task.

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

Status code: 200

Canceling a SQL execution task is successful.

{
  "status" : "SUCCEED"
}

Status code: 400

Failed to cancel a SQL execution task.

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

Parent topic: SQL APIs

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.