文档首页/ 智能数据湖 AI DataLake/ API参考/ Aura相关API/ AuraSQL作业管理/ 查看SQL执行记录 - ListAuraV2StatementRecords
更新时间：2026-10-19 GMT+08:00
查看PDF
分享

查看SQL执行记录 - ListAuraV2StatementRecords

功能介绍

查询SQL执行记录。

此接口为同步接口，无配套使用接口和特殊场景。

调用方法

请参见如何调用API。

URI

GET /v2/workspaces/{workspace_id}/aura-statement-records

表1 路径参数

参数

是否必选

参数类型

描述

workspace_id

是

String

参数解释：工作空间的ID。获取方法请参见获取工作空间ID。

约束限制：不涉及。

取值范围：长度为1~36个字符，支持大小写英文字母、数字、连字符。

默认取值：不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

endpoint_name

是

String

参数解释：Endpoint（端点）的名称，用于通过名称检索对应的Endpoint。

约束限制：不涉及。

取值范围：长度为1~128个字符，支持大小写英文字母、数字、点号、中文、下划线、连字符、空格。

默认取值：不涉及。

session_id

否

String

参数解释：Session的ID。可通过查看Session列表接口获取session_id。

约束限制：不涉及。

取值范围：长度为1~36个字符，支持大小写英文字母、数字、连字符。

默认取值：不涉及。

statement_id

否

String

参数解释：执行语句ID。可通过查看指定Session下的SQL执行记录接口获取statement_id。

约束限制：不涉及。

取值范围：长度为1~36个字符，支持大小写英文字母、数字、下划线、连字符。

默认取值：不涉及。

status

否

String

参数解释：状态过滤，支持一种状态查询。

约束限制：不涉及。

取值范围：

  • CANCELED：已取消。

  • FAILED：失败。

  • SUCCESSFUL：成功。

  • RUNNING：运行中。

  • SUBMITTED：已提交。

  • ERROR：错误。

  • WAITING：等待中。

默认取值：不传时查询所有状态。

start_time_before

否

Integer

参数解释：查询start_time早于该时间点的记录（含该时间点），时间戳，单位：秒。

约束限制：不涉及。

取值范围：1~2147483647。

默认取值：不涉及。

start_time_after

否

Integer

参数解释：查询start_time晚于该时间点的记录（含该时间点），时间戳，单位：秒。

约束限制：不涉及。

取值范围：1~2147483647。

默认取值：不涉及。

marker

否

String

参数解释：上一页中最后一条记录id，查询第一页时传空值。

约束限制：不涉及。

取值范围：长度为1~64个字符，支持大小写英文字母、数字、下划线、连字符。

默认取值：不涉及。

limit

否

Integer

参数解释：指定每一页返回的最大条目数。

约束限制：不涉及。

取值范围：1~100。

默认取值：10。

statement_type

否

String

参数解释：作业类型过滤（SQL/JOB），不传时返回所有类型。

约束限制：不涉及。

取值范围：SQL、JOB。

默认取值：不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：用户Token，通过调用获取IAM用户Token接口获取。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

current_count

Integer

参数解释：本次查询记录总数。

取值范围：1~2147483647。

next_marker

String

参数解释：下一页查询marker值，若为空表示当前已是最后一页。

取值范围：长度为1~64个字符，支持大小写英文字母、数字、下划线、连字符。

records

Array of StatementRecord objects

参数解释：SQL历史记录列表，每个元素为StatementRecord对象，包含执行语句ID、工作空间ID、端点名称、会话ID、数据库名称、SQL脚本内容、执行时长、执行状态、用户名称、创建时间等信息。
表5 StatementRecord

参数

参数类型

描述

id

String

参数解释：执行语句ID。

取值范围：长度为1~36个字符，支持大小写英文字母、数字、下划线、连字符。

workspace_id

String

参数解释：工作空间ID。

取值范围：长度为1~36个字符，支持大小写英文字母、数字、连字符。

endpoint_name

String

参数解释：端点名称。

取值范围：长度为1~128个字符，支持大小写英文字母、数字、点号、中文、下划线、连字符、空格。

session_id

String

参数解释：Session的ID。可通过查看Session列表接口获取session_id。

取值范围：长度为1~36个字符，支持大小写英文字母、数字、连字符。

database_name

String

参数解释：数据库名称。

取值范围：长度为1~256个字符，支持大小写英文字母、数字、下划线。

statement_content

String

参数解释：SQL脚本内容。

取值范围：长度为0~8096个字符。

duration

String

参数解释：执行时长（单位：ms）。

取值范围：不涉及。

status

String

参数解释：SQL执行状态。

取值范围：

  • CANCELED：已取消。

  • FAILED：失败。

  • SUCCESSFUL：成功。

  • RUNNING：运行中。

  • SUBMITTED：已提交。

  • ERROR：错误。

  • WAITING：等待中。

user_name

String

参数解释：用户名称。

取值范围：长度为1~64个字符，支持大小写英文字母、数字、下划线。

create_time

String

参数解释：SQL创建时间格式为ISO 8601标准时间。例如：2023-05-30T12:24:30.401Z。

取值范围：不涉及。

start_time

String

参数解释：SQL执行开始时间，格式为ISO 8601标准时间。例如：2023-05-30T12:24:30.401Z。

取值范围：不涉及。

finish_time

String

参数解释：SQL执行结束时间，格式为ISO 8601标准时间。例如：2023-05-30T12:24:30.401Z。

取值范围：不涉及。

tuple_processed

Long

参数解释：已处理行数，仅JOB类型返回，SQL类型返回null。

取值范围：不涉及。

statement_type

String

参数解释：作业类型（SQL/JOB）。

取值范围：SQL、JOB。

statement_name

String

参数解释：作业名称。

取值范围：不涉及。

error

ErrorMessage object

参数解释：失败时返回的错误对象，包含错误码、错误描述和解决方案。

取值范围：不涉及。
表6 ErrorMessage

参数

参数类型

描述

error_code

String

参数解释：错误码。

取值范围：长度为8~36个字符。

error_msg

String

参数解释：错误描述。

取值范围：长度为2~4096个字符。

solution_msg

String

参数解释：解决方案描述。

取值范围：长度为2~4096个字符。

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

取值范围：长度为8~36个字符。

error_msg

String

参数解释：错误描述。

取值范围：长度为2~4096个字符。

solution_msg

String

参数解释：解决方案描述。

取值范围：长度为2~4096个字符。

状态码：401

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

取值范围：长度为8~36个字符。

error_msg

String

参数解释：错误描述。

取值范围：长度为2~4096个字符。

solution_msg

String

参数解释：解决方案描述。

取值范围：长度为2~4096个字符。

状态码：403

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

取值范围：长度为8~36个字符。

error_msg

String

参数解释：错误描述。

取值范围：长度为2~4096个字符。

solution_msg

String

参数解释：解决方案描述。

取值范围：长度为2~4096个字符。

状态码：404

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

取值范围：长度为8~36个字符。

error_msg

String

参数解释：错误描述。

取值范围：长度为2~4096个字符。

solution_msg

String

参数解释：解决方案描述。

取值范围：长度为2~4096个字符。

状态码：408

表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

取值范围：长度为8~36个字符。

error_msg

String

参数解释：错误描述。

取值范围：长度为2~4096个字符。

solution_msg

String

参数解释：解决方案描述。

取值范围：长度为2~4096个字符。

状态码：500

表12 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

取值范围：长度为8~36个字符。

error_msg

String

参数解释：错误描述。

取值范围：长度为2~4096个字符。

solution_msg

String

参数解释：解决方案描述。

取值范围：长度为2~4096个字符。

请求示例

查询SQL执行历史记录。

GET /v2/workspaces/{workspace_id}/aura-statement-records?endpoint_name=endpoint1

响应示例

状态码：200

{
  "current_count" : 1,
  "next_marker" : null,
  "records" : [ {
    "id" : "0b5633ba2b904511ad514346f4dxxxxx",
    "workspace_id" : "0b5633ba2b904511ad514346f4dxxxxx",
    "session_id" : "019ff0ee-740c-7eca-b40b-f8cf38c7b6f0",
    "endpoint_name" : "endpoint_1",
    "database_name" : "db1",
    "statement_content" : "select 1",
    "duration" : "332",
    "status" : "SUCCESSFUL",
    "user_name" : "user1",
    "create_time" : "2023-05-30T12:24:30.401Z",
    "start_time" : "2023-05-30T12:24:30.401Z",
    "finish_time" : "2023-05-30T12:24:30.401Z"
  } ]
}

状态码：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

服务器内部错误。
父主题： AuraSQL作业管理

相关文档