查看指定Session下的SQL执行记录 - ListAuraV2SessionStatementRecords

功能介绍

查询指定Session下的SQL执行记录。

输入workspace_id，session_id，statement_id（可选），status（可选），分页查询参数limit和marker；输出此会话下SQL执行记录。

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

调用方法

请参见如何调用API。

URI

GET /v2/workspaces/{workspace_id}/aura-sessions/{session_id}/statements

表1 路径参数
参数	是否必选	参数类型	描述
workspace_id	是	String	参数解释：工作空间的ID。约束限制：不涉及。取值范围：长度为1~36个字符，支持大小写英文字母、数字、连字符。默认取值：不涉及。
session_id	是	String	参数解释：会话ID。约束限制：不涉及。取值范围：长度为1~36个字符，支持大小写英文字母、数字、连字符。默认取值：不涉及。

表2 Query参数
参数	是否必选	参数类型	描述
limit	否	Integer	参数解释：指定每一页返回的最大条目数。约束限制：不涉及。取值范围：1~100。默认取值：10。
marker	否	String	参数解释：上一页中最后一条记录id，查询第一页时传空值。约束限制：不涉及。取值范围：长度为1~36个字符，支持大小写英文字母、数字、连字符。默认取值：不涉及。
statement_id	否	String	参数解释：statement id。约束限制：不涉及。取值范围：长度为1~36个字符，支持大小写英文字母、数字、连字符。默认取值：不涉及。
status	否	String	参数解释：状态过滤，支持一种状态查询，默认查询所有。约束限制：不涉及。取值范围： CANCELED：已取消。 FAILED：失败。 SUCCESSFUL：成功。 RUNNING：运行中。 SUBMITTED：已提交。 ERROR：错误。默认取值：不涉及。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：租户token。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
records	Array of SessionStatementRecord objects	参数解释：本次查询记录。取值范围：不涉及。
current_count	Integer	参数解释：本次查询记录总数。取值范围：1~2147483647。
next_marker	String	参数解释：下一页查询marker值，若为空表示当前已是最后一页。取值范围：长度为1~64个字符，支持大小写英文字母、数字、连字符。

表5 SessionStatementRecord
参数	参数类型	描述
statement_id	String	参数解释：statement id。取值范围：长度为1~36的英文字母、数字、连字符和下划线的组合。
statement_content	String	参数解释：查询语句。取值范围：不涉及。
create_time	String	参数解释：创建时间，时间戳，单位：毫秒。取值范围：不涉及。
status	String	参数解释：状态。取值范围： CANCELED：取消。 FAILED：失败。 SUCCESSFUL：成功。 RUNNING：运行中。 SUBMITTED：提交。 ERROR：错误。
user_name	String	参数解释：用户名称。取值范围：长度为1~64个字符，支持大小写英文字母、数字、下划线。

状态码：400

表6 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。取值范围：长度为8~36个字符。
error_msg	String	参数解释：错误描述。取值范围：长度为2~4096个字符。
solution_msg	String	参数解释：解决方案描述。取值范围：长度为2~4096个字符。

状态码：401

表7 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。取值范围：长度为8~36个字符。
error_msg	String	参数解释：错误描述。取值范围：长度为2~4096个字符。
solution_msg	String	参数解释：解决方案描述。取值范围：长度为2~4096个字符。

状态码：403

表8 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。取值范围：长度为8~36个字符。
error_msg	String	参数解释：错误描述。取值范围：长度为2~4096个字符。
solution_msg	String	参数解释：解决方案描述。取值范围：长度为2~4096个字符。

状态码：404

表9 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。取值范围：长度为8~36个字符。
error_msg	String	参数解释：错误描述。取值范围：长度为2~4096个字符。
solution_msg	String	参数解释：解决方案描述。取值范围：长度为2~4096个字符。

状态码：408

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。取值范围：长度为8~36个字符。
error_msg	String	参数解释：错误描述。取值范围：长度为2~4096个字符。
solution_msg	String	参数解释：解决方案描述。取值范围：长度为2~4096个字符。

状态码：500

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。取值范围：长度为8~36个字符。
error_msg	String	参数解释：错误描述。取值范围：长度为2~4096个字符。
solution_msg	String	参数解释：解决方案描述。取值范围：长度为2~4096个字符。

请求示例

查询SQL执行历史记录，返回值包含执行的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"
  } ],
  "total" : 2
}

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

状态码：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 not exists.",
  "solution_msg" : "Please try to use correct info."
}

状态码：408

请求超时。

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

状态码：500

服务器内部错误。

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error"
}

状态码

状态码	描述
200	请求成功。
400	非法请求。
401	未经授权。
403	请求被拒绝访问。
404	所请求的资源不存在。
408	请求超时。
500	服务器内部错误。