查看SQL执行记录 - ListAuraV2StatementRecords

功能介绍

查询SQL执行记录。查询指定Session下的SQL执行记录。输入workspace_id，session_id，statement_id（可选），status（可选），分页查询参数limit和marker；输出此会话下SQL执行记录。此接口为同步接口，无配套使用接口和特殊场景。

调用方法

请参见如何调用API。

URI

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

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

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

请求参数

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

响应参数

状态码：200

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

表5 StatementRecord
参数	参数类型	描述
id	String	参数解释：Sql执行StatementID。取值范围：不涉及。
workspace_id	String	参数解释：工作空间ID。取值范围：长度为1~36个字符，支持大小写英文字母、数字、连字符。
endpoint_id	String	参数解释：端点ID。取值范围：长度为1~64个字符，支持大小写英文字母、数字、连字符。
session_id	String	参数解释：Session的ID。取值范围：长度为1~36个字符，支持大小写英文字母、数字、连字符。
database_name	String	参数解释：数据库名称。取值范围：长度为1~256个字符，支持大小写英文字母、数字、下划线。
statement_content	String	参数解释：sql脚本内容。取值范围：长度为1~256个字符，支持大小写英文字母、数字、下划线。
duration	String	参数解释：执行时长。取值范围：不涉及。
status	String	参数解释：Sql执行状态。取值范围： CANCELED：取消。 FAILED：失败。 SUCCESSFUL：成功。 RUNNING：运行中。 SUBMITTED：提交。 ERROR：错误。
user_name	String	参数解释：用户名称。取值范围：长度为1~64个字符，支持大小写英文字母、数字、下划线。
create_time	String	参数解释：sql创建时间，用于记录sql语句创建时间。取值范围：unix时间戳，单位为毫秒。
start_time	String	参数解释：sql执行开始时间，时间戳，单位：毫秒。取值范围：不涉及。
finish_time	String	参数解释：sql执行结束时间，时间戳，单位：毫秒。取值范围：不涉及。

状态码：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执行历史记录。

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

{ }

响应示例

状态码：200

请求成功。

{
  "current_count" : 1,
  "next_marker" : "0b5633ba2b904511ad514346f4dxxxxx",
  "records" : [ {
    "id" : "0b5633ba2b904511ad514346f4dxxxxx",
    "workspace_id" : "0b5633ba2b904511ad514346f4d23d4b",
    "endpoint_name" : "endpoint_1",
    "database_name" : "db1",
    "statement_content" : "select 1",
    "dpu_duration" : 2.23,
    "dpu_cost" : 10.11,
    "duration" : 332,
    "status" : "SUCCESSFUL",
    "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"
}

状态码：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	服务器内部错误。