查看指定Session下的SQL执行记录 - ListAuraV2SessionStatementRecords
功能介绍
查询指定Session下的SQL执行记录。
此接口为同步接口,无配套使用接口和特殊场景。
调用方法
请参见如何调用API。
URI
GET /v2/workspaces/{workspace_id}/aura-sessions/{session_id}/statements
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| workspace_id | 是 | String | 参数解释:工作空间的ID。获取方法请参见获取工作空间ID。 约束限制:不涉及。 取值范围:长度为1~36个字符,支持大小写英文字母、数字、连字符。 默认取值:不涉及。 |
| session_id | 是 | String | 参数解释:会话ID。可通过查看Session列表接口获取session_id。 约束限制:不涉及。 取值范围:长度为1~36个字符,支持大小写英文字母、数字、连字符。 默认取值:不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释:指定每一页返回的最大条目数。 约束限制:不涉及。 取值范围:1~100。 默认取值:10。 |
| marker | 否 | String | 参数解释:上一页中最后一条记录id,查询第一页时传空值。 约束限制:不涉及。 取值范围:长度为1~64个字符,支持大小写英文字母、数字、下划线、连字符。 默认取值:不涉及。 |
| statement_id | 否 | String | 参数解释:执行语句ID。可通过查看指定Session下的SQL执行记录接口获取statement_id。 约束限制:不涉及。 取值范围:长度为1~36个字符,支持大小写英文字母、数字、下划线、连字符。 默认取值:不涉及。 |
| status | 否 | String | 参数解释:状态过滤,支持一种状态查询。 约束限制:不涉及。 取值范围: 默认取值:不传时查询所有状态。 |
| statement_type | 否 | String | 参数解释:作业类型过滤(SQL/JOB),不传时返回所有类型。 约束限制:不涉及。 取值范围:SQL、JOB。 默认取值:不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释:用户Token,通过调用获取IAM用户Token接口获取。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| records | Array of SessionStatementRecord objects | 参数解释:本次查询记录。 取值范围:不涉及。 |
| current_count | Integer | 参数解释:本次查询记录总数。 取值范围:1~2147483647。 |
| next_marker | String | 参数解释:下一页查询marker值,若为空表示当前已是最后一页。 取值范围:长度为1~64个字符,支持大小写英文字母、数字、下划线、连字符。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| statement_id | String | 参数解释:执行语句ID。 取值范围:长度为1~36个字符,支持大小写英文字母、数字、下划线、连字符。 |
| statement_content | String | 参数解释:查询语句。 取值范围:不涉及。 |
| create_time | String | 参数解释:创建时间,格式为ISO 8601标准时间。例如:2023-05-30T12:24:30.401Z 取值范围:不涉及。 |
| status | String | 参数解释:状态。 取值范围: |
| user_name | String | 参数解释:用户名称。 取值范围:长度为1~64个字符,支持大小写英文字母、数字、下划线。 |
| tuple_processed | Long | 参数解释:已处理行数,仅JOB类型返回,SQL类型返回null。 取值范围:不涉及。 |
| statement_type | String | 参数解释:作业类型(SQL/JOB)。 取值范围:SQL、JOB。 |
| statement_name | String | 参数解释:作业名称。 取值范围:不涉及。 |
| error | ErrorMessage object | 参数解释:失败时返回的错误对象,包含错误码、错误描述和解决方案。 取值范围:不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码。 取值范围:长度为8~36个字符。 |
| error_msg | String | 参数解释:错误描述。 取值范围:长度为2~4096个字符。 |
| solution_msg | String | 参数解释:解决方案描述。 取值范围:长度为2~4096个字符。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码。 取值范围:长度为8~36个字符。 |
| error_msg | String | 参数解释:错误描述。 取值范围:长度为2~4096个字符。 |
| solution_msg | String | 参数解释:解决方案描述。 取值范围:长度为2~4096个字符。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码。 取值范围:长度为8~36个字符。 |
| error_msg | String | 参数解释:错误描述。 取值范围:长度为2~4096个字符。 |
| solution_msg | String | 参数解释:解决方案描述。 取值范围:长度为2~4096个字符。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码。 取值范围:长度为8~36个字符。 |
| error_msg | String | 参数解释:错误描述。 取值范围:长度为2~4096个字符。 |
| solution_msg | String | 参数解释:解决方案描述。 取值范围:长度为2~4096个字符。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码。 取值范围:长度为8~36个字符。 |
| error_msg | String | 参数解释:错误描述。 取值范围:长度为2~4096个字符。 |
| solution_msg | String | 参数解释:解决方案描述。 取值范围:长度为2~4096个字符。 |
状态码:408
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码。 取值范围:长度为8~36个字符。 |
| error_msg | String | 参数解释:错误描述。 取值范围:长度为2~4096个字符。 |
| solution_msg | String | 参数解释:解决方案描述。 取值范围:长度为2~4096个字符。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:错误码。 取值范围:长度为8~36个字符。 |
| error_msg | String | 参数解释:错误描述。 取值范围:长度为2~4096个字符。 |
| solution_msg | String | 参数解释:解决方案描述。 取值范围:长度为2~4096个字符。 |
请求示例
查询SQL执行历史记录。
GET /v2/workspaces/{workspace_id}/aura-sessions/{session_id}/statements 响应示例
状态码:200
{
"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"
} ],
"current_count" : 2,
"next_marker" : null
} 状态码:400
{
"error_code" : "AIDataLake.00092031",
"error_msg" : "Invalid parameter name",
"solution_msg" : "Please enter parameters in the correct format."
} 状态码:401
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed",
"solution_msg" : "Please obtain a valid token and retry."
} 状态码:403
{
"error_code" : "AIDataLake.00090030",
"error_msg" : "Unauthorized requests.",
"solution_msg" : "Check permissions and retry after authorization."
} 状态码:404
{
"error_code" : "AIDataLake.00090009",
"error_msg" : "The resource does not exist.",
"solution_msg" : "Please try to use correct info."
} 状态码:408
{
"error_code" : "common.00000408",
"error_msg" : "A timeout exception occurred.",
"solution_msg" : "The request timed out while waiting for a response — check the backend service status and network, then retry; if the operation is long-running, increase the client timeout or split the request."
} 状态码:500
{
"error_code" : "common.00000500",
"error_msg" : "internal error",
"solution_msg" : "An internal service error occurred. Please retry later; if the problem persists, contact technical support."
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功。 |
| 400 | 非法请求。 |
| 401 | 未经授权。 |
| 403 | 请求被拒绝访问。 |
| 404 | 所请求的资源不存在。 |
| 408 | 请求超时。 |
| 500 | 服务器内部错误。 |