Executes an SQL query script task.
Try it now
Test
RAM authorization
Request syntax
POST /api/v2/namespaces/{namespace}/sql-execution/{sqlExecutionId}:stop HTTP/1.1
Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| namespace |
string |
No |
The namespace name. |
default-namespace |
| sqlExecutionId |
string |
No |
The unique ID of the SQL query execution result. |
exec-sql-20250405abc |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| workspace |
string |
Yes |
The workspace ID. |
a14bd5d90a**** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response data. |
||
| requestId |
string |
The request ID. |
CBC799F0-AS7S-1D30-8A4F-882ED4DD**** |
| success |
boolean |
Indicates whether the business request was successful. |
True |
| httpCode |
integer |
The business status code, which is always 200. Use success to determine whether the business request was successful. |
200 |
| errorCode |
string |
The business error code. This parameter is not empty when success is false. This parameter is empty when success is true. |
"" |
| errorMessage |
string |
The business error message. This parameter is not empty when success is false. This parameter is empty when success is true. |
"" |
| data |
object |
SqlExecutionStopResult |
|
| success |
boolean |
Indicates whether the stop instruction was successfully initiated. |
True |
| message |
string |
The supplementary information about stopping the query script. |
“” |
Examples
Success response
JSON format
{
"requestId": "CBC799F0-AS7S-1D30-8A4F-882ED4DD****",
"success": true,
"httpCode": 200,
"errorCode": "\"\"",
"errorMessage": "\"\"",
"data": {
"success": true,
"message": "“”"
}
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.