Querying SQL Execution Records in a Specified Session
Function
This API is used to query the SQL execution records of a specified session.
URI
GET /v1/workspaces/{workspace_id}/sessions/{session_id}/statements
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
workspace_id |
Yes |
String |
Definition: Workspace ID. Constraints: N/A. Range: 1 to 36 characters. Only letters, digits, and hyphens (-) are allowed. Default Value: N/A. |
session_id |
Yes |
String |
Definition: Session ID. Constraints: N/A. Range: 1 to 36 characters. Only letters, digits, and hyphens (-) are allowed. Default Value: N/A. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
Definition: Maximum number of records returned on each page. Constraints: N/A. Range: [1, 100]. Default Value: 10. |
offset |
No |
Integer |
Definition: Offset where a query starts. Constraints: N/A. Range: [0, 1000000000]. Default Value: 0. |
statement_id |
No |
String |
Definition: Statement ID. Constraints: N/A. Range: 1 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. Default Value: N/A. |
status |
No |
String |
CANCELED, FAILED, SUCCESSFUL, RUNNING, SUBMITTED, or ERROR |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
Definition: Tenant token. Constraints: N/A. Range: N/A. Default Value: N/A. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
records |
Array of records objects |
|
total |
Integer |
|
Parameter |
Type |
Description |
---|---|---|
statement_id |
String |
|
statement_content |
String |
Value range: a string of 0 to 2147483647 characters. |
create_time |
String |
|
status |
String |
|
user_name |
String |
|
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition: Error code. Constraints: N/A. Range: [8, 36]. Default Value: N/A. |
error_msg |
String |
Definition: Error message. Constraints: N/A. Range: [2, 4096]. Default Value: N/A. |
solution_msg |
String |
Definition: Solution description. Constraints: N/A. Range: [2, 4096]. Default Value: N/A. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition: Error code. Constraints: N/A. Range: [8, 36]. Default Value: N/A. |
error_msg |
String |
Definition: Error message. Constraints: N/A. Range: [2, 4096]. Default Value: N/A. |
solution_msg |
String |
Definition: Solution description. Constraints: N/A. Range: [2, 4096]. Default Value: N/A. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition: Error code. Constraints: N/A. Range: [8, 36]. Default Value: N/A. |
error_msg |
String |
Definition: Error message. Constraints: N/A. Range: [2, 4096]. Default Value: N/A. |
solution_msg |
String |
Definition: Solution description. Constraints: N/A. Range: [2, 4096]. Default Value: N/A. |
Status code: 408
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition: Error code. Constraints: N/A. Range: [8, 36]. Default Value: N/A. |
error_msg |
String |
Definition: Error message. Constraints: N/A. Range: [2, 4096]. Default Value: N/A. |
solution_msg |
String |
Definition: Solution description. Constraints: N/A. Range: [2, 4096]. Default Value: N/A. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition: Error code. Constraints: N/A. Range: [8, 36]. Default Value: N/A. |
error_msg |
String |
Definition: Error message. Constraints: N/A. Range: [2, 4096]. Default Value: N/A. |
solution_msg |
String |
Definition: Solution description. Constraints: N/A. Range: [2, 4096]. Default Value: N/A. |
Example Requests
Query the SQL execution history. The returned values include the executed SQL statement, start time, and status.
GET https://endpoint/v1/workspaces/{workspace_id}/sessions/{session_id}/statements { }
Example Responses
Status code: 200
Response body for querying SQL statements under a session.
{ "records" : [ { "statement_id" : "4272****02409", "statement_content" : "select 1", "create_time" : "2025-07-22T08:44:00.000+00:00", "status" : "FAILED", "user_name" : "example" }, { "statement_id" : "ba5e****78fd", "statement_content" : "select 1", "create_time" : "2025-07-22T08:43:58.000+00:00", "status" : "SUCCESSFUL", "user_name" : "example" } ], "total" : 2 }
Status code: 400
BadRequest
{ "error_code" : "common.01000001", "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException" }
Status code: 401
Unauthorized
{ "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" }
Status code: 403
Forbidden
{ "error" : { "code" : "403", "message" : "X-Auth-Token is invalid in the request", "title" : "Forbidden" }, "error_code" : 403, "error_msg" : "X-Auth-Token is invalid in the request", "title" : "Forbidden" }
Status code: 404
NotFound
{ "error_code" : "common.01000001", "error_msg" : "response status exception, code: 404" }
Status code: 408
Request Time-out
{ "error_code" : "common.00000408", "error_msg" : "timeout exception occurred" }
Status code: 500
InternalServerError
{ "error_code" : "common.00000500", "error_msg" : "internal error" }
Status Codes
Status Code |
Description |
---|---|
200 |
Response body for querying SQL statements under a session. |
400 |
BadRequest |
401 |
Unauthorized |
403 |
Forbidden |
404 |
NotFound |
408 |
Request Time-out |
500 |
InternalServerError |
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