查看Session列表 - ListAuraV2SqlSessions

功能介绍

查询SQL Session列表。

输入workspace_id，endpoint_name（可选），status（可选），session_id（可选），start_time（可选），end_time（可选）,分页查询参数limit和marker；输出SQL会话列表，包含会话id、会话创建时间、结束时间、会话状态等信息。

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

调用方法

请参见如何调用API。

URI

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

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

表2 Query参数
参数	是否必选	参数类型	描述
endpoint_name	是	String	参数解释：通过name检索Endpoint的参数。约束限制：不涉及。取值范围：长度为1~36个字符，支持大小写英文字母、数字、连字符。默认取值：不涉及。
session_id	否	String	参数解释：会话ID。约束限制：不涉及。取值范围：长度为1~36个字符，支持大小写英文字母、数字、连字符。默认取值：不涉及。
status	否	String	参数解释：状态过滤，支持一种状态查询，默认查询所有。约束限制：不涉及。取值范围： RUNNING：运行中。 CLOSED：已关闭。 WAITING：等待中。 CREATING：创建中。 FAIL：失败。默认取值：不涉及。
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参数
参数	参数类型	描述
next_marker	String	参数解释：下一页查询marker值，若为空表示当前已是最后一页。取值范围：不涉及。
total	Integer	参数解释：总数。取值范围：1~2147483647。
sessions	Array of SqlSessionInfo objects	参数解释：Session列表。

表5 SqlSessionInfo
参数	参数类型	描述
session_id	String	参数解释：Session的ID。取值范围：长度为1~36个字符，支持大小写英文字母、数字、连字符。
status	String	参数解释：SQL会话状态。取值范围： RUNNING：运行中。 CLOSED：已关闭。 WAITING：等待中。 CREATING：创建中。 FAIL：失败。
create_time	String	参数解释：session创建时间。取值范围：不涉及。
endpoint_info	endpoint_info object	参数解释：端点信息。

表6 endpoint_info
参数	参数类型	描述
id	String	参数解释：端点ID。取值范围：长度为1~64个字符，支持大小写英文字母、数字、连字符。
name	String	参数解释：Endpoint名称。约束限制：不涉及。取值范围：长度为1~128个字符，支持大小写英文字母、数字、连字符。默认取值：不涉及。

状态码：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个字符。

请求示例

查询Session列表信息，返回值为Session状态、创建时间、端点等信息。

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

{ }

响应示例

状态码：200

请求成功。

{
  "sessions" : [ {
    "session_id" : "284888e2-c36f-4bec-9b24-e5bf0b386ab0",
    "status" : "RUNNING",
    "create_time" : "2025-07-22T08:42:39.000+00:00",
    "endpoint_info" : {
      "id" : "0470d220-aaaa-410e-a417-0d69a0215683",
      "name" : "test2"
    }
  }, {
    "session_id" : "4e4b2770-702f-48b7-9737-db107cf63e24",
    "status" : "CLOSED",
    "create_time" : "2025-07-22T06:13:47.000+00:00",
    "endpoint_info" : {
      "id" : "0470d220-aaaa-410e-a417-0d69a0215683",
      "name" : "test2"
    }
  } ],
  "total" : 15
}

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