Retrieves the execution result of an SQL data query submitted through the platform.
Try it now
Test
RAM authorization
Request syntax
GET /api/v2/namespaces/{namespace}/sql-execution/{sqlExecutionId}:fetchSqlExecutionResult 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, returned by the StartSqlExecution operation. |
exec-sql-20250405abc |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| workspace |
string |
No |
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. The value is always 200. Use success to determine whether the request was successful. |
200 |
| errorCode |
string |
The business error code. This value is not empty when success is false. This value is empty when success is true. |
"" |
| errorMessage |
string |
The business error message. This value is not empty when success is false. This value is empty when success is true. |
"" |
| data | SqlExecutionFetchResult |
The execution result details returned when the request is successful. |
{ "jobs": [ { "jid": "4df35f8e54554b23bf7dcd38a151****", "name": "69d001d5-419a-4bfc-9c2e-849cacd3****", "state": "RUNNING", "start-time": 1659154942068, "end-time": -1, "duration": 188161756, "last-modification": 1659154968305, "tasks": { "total": 2, "created": 0, "scheduled": 0, "deploying": 0, "running": 2, "finished": 0, "canceling": 0, "canceled": 0, "failed": 0, "reconciling": 0, "initializing": 0 } } ] } |
Examples
Success response
JSON format
{
"requestId": "CBC799F0-AS7S-1D30-8A4F-882ED4DD****",
"success": true,
"httpCode": 200,
"errorCode": "\"\"",
"errorMessage": "\"\"",
"data": {
"sqlExecution": {
"namespace": "default-namespace",
"workspace": "edcef******b4f",
"sqlExecutionId": "",
"name": "",
"description": "",
"sessionClusterName": "",
"sqlFileId": "",
"sqlScript": "",
"batchMode": false,
"state": "",
"message": "",
"statements": [
{
"index": 0,
"sqlScript": "",
"type": "",
"statusState": "",
"message": ""
}
]
},
"dqlResult": {
"statementIndex": 0,
"submitPreviewResult": {
"queryId": "",
"sessionId": "",
"tableSchemas": [
{
"tableName": "",
"schema": {
"columns": [
{
"name": "name",
"metadataInfo": {
"key": "topic",
"virtual": false
},
"expression": "“”",
"type": "string",
"nullable": true,
"logicalType": ""
}
],
"watermarkSpecs": [
{
"column": "time",
"watermarkExpression": "INTERVAL '5' SECOND",
"watermarkType": ""
}
],
"primaryKey": [
{
"constraintName": "pk",
"columns": [
"id"
],
"constraintType": "",
"enforced": false
}
]
},
"collectSinkOperatorId": ""
}
]
},
"tableResults": [
{
"tableName": "",
"collectSinkOperatorId": "",
"rowUpdates": [
{
"rowKind": "",
"row": {
"cells": [
{
"value": ""
}
]
}
}
]
}
]
}
}
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.