Canceling a SQL Execution Task
Function
This API is used to cancel the execution task of a SQL statement in an MRS cluster.
Constraints
None
Debugging
You can debug this API in API Explorer. Automatic authentication is supported. API Explorer can automatically generate sample SDK code and provide the sample SDK code debugging.
URI
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
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
message |
String |
The error message. |
status |
String |
The result of canceling the execution of the SQL statement. Possible values: 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. Enumerated values:
|
Status code: 400
Parameter |
Type |
Description |
---|---|---|
message |
String |
The error message. |
status |
String |
The result of canceling the execution of the SQL statement. Possible values: 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. Enumerated values:
|
Example Request
Cancel a SQL execution task.
POST https://{endpoint}/v2/{project_id}/clusters/{cluster_id}/sql-execution/{sql_id}/cancel
Example Response
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" }
Status Codes
See Status Codes.
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot