文档首页/ 数智融合计算服务 DataArtsFabric/ API参考/ API/ SQL业务接口/ 获取SQL Session列表
更新时间：2025-09-15 GMT+08:00
查看PDF
分享

获取SQL Session列表

功能介绍

查询SQL Session列表

URI

GET /v1/workspaces/{workspace_id}/sessions

表1 路径参数

参数

是否必选

参数类型

描述

workspace_id

是

String

参数解释：工作空间的ID。

约束限制：不涉及。

取值范围：长度为[1,36]的字母、数字、中划线(-)的组合。

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

参数

是否必选

参数类型

描述

endpoint_id

否

String

参数解释：通过ID检索Endpoint的参数。

约束限制：不涉及。

取值范围：长度为[1,36]的字母、数字、中划线(-)的组合。

默认取值：不涉及。

status

否

String

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

约束限制：不涉及。

取值范围：可选值有：RUNNING、CLOSED、WAITING、CREATING、FAIL

默认取值：不涉及。

session_id

否

String

参数解释：SessionId的ID。

约束限制：不涉及。

取值范围：长度为[1,36]的字母、数字、中划线(-)的组合。

默认取值：不涉及。

limit

否

Integer

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

约束限制：不涉及。

取值范围：[1,100]。

默认取值：10。

offset

否

Integer

参数解释：偏移量，表示从此偏移量开始查询。

约束限制：不涉及。

取值范围：[0,1000000000]。

默认取值：0。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

参数解释：租户token。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

sessions

Array of SqlSessionInfo objects

参数解释：Session列表。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

total

Integer

总数
表5 SqlSessionInfo

参数

参数类型

描述

session_id

String

参数解释：Session的ID。

约束限制：不涉及。

取值范围：长度为[1,36]的英文字符、数字和中划线(-)等特殊字符的组合。

默认取值：不涉及。

status

String

参数解释：

  • RUNNING-运行中

  • CLOSED-已关闭

  • WAITING-等待中

  • CREATING-创建中

  • FAIL-失败

约束限制：不涉及。

取值范围： RUNNING、CLOSED、WAITING、CREATING、FAIL

默认取值：不涉及。

create_time

String

参数解释：session创建时间。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

endpoint_info

endpoint_info object

参数解释：创建Session的端点信息。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。
表6 endpoint_info

参数

参数类型

描述

id

String

参数解释：端点ID。

约束限制：不涉及。

取值范围：长度为[1,36]的字母、数字、中划线(-)的组合。

默认取值：不涉及。

name

String

参数解释：Endpoint名称。

约束限制：只能包含中文、字母、数字、下划线、中划线、点、空格。

取值范围：不涉及。

默认取值：不涉及。

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

默认取值：不涉及。

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

默认取值：不涉及。

请求示例

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

GET https://endpoint/v1/workspaces/{workspace_id}/sessions?endpoint_id=

{ }

响应示例

状态码：200

Session列表响应体

{
  "sessions" : [ {
    "session_id" : "284888e2-c36f-4bec-9b24-e5bf0b386ab0",
    "status" : "RUNINNG",
    "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

BadRequest

{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}

状态码：401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码：403

Forbidden

{
  "error" : {
    "code" : "403",
    "message" : "X-Auth-Token is invalid in the request",
    "title" : "Forbidden"
  },
  "error_code" : 403,
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}

状态码：404

NotFound

{
  "error_code" : "common.01000001",
  "error_msg" : "response status exception, code: 404"
}

状态码：408

Request Time-out

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

状态码：500

InternalServerError

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

状态码

状态码

描述

200

Session列表响应体

400

BadRequest

401

Unauthorized

403

Forbidden

404

NotFound

408

Request Time-out

500

InternalServerError

错误码

请参见错误码。

父主题： SQL业务接口