Canceling a SQL Execution Task

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

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

Parameter description

**Table 1** URI parameters
Parameter	Mandatory	Description
project_id	Yes	The project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
cluster_id	Yes	The cluster ID. For details about how to obtain the cluster ID, see Obtaining a Cluster ID.
sql_id	Yes	The execution ID of a SQL statement, that is, sql_id in the return result in Submitting a SQL Statement.

Request parameters

None

**Table 2** Response parameters
Parameter	Type	Description
status	String	The result of canceling the execution of the SQL statement. Possible values: SUCCEED: successful FAILED: failed NOTE: 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.
message	String	The error message.

Example request

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

Example response

Example of a failed response

{ 
    "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.