文档首页/ 智能体开发平台 AgentArts/ API参考/ API/ 沙箱工具/ 代码解释器数据面接口/ 查询session - ShowCodeInterpreterSession
更新时间：2026-05-07 GMT+08:00
查看PDF
分享

查询session - ShowCodeInterpreterSession

功能介绍

该API用于查询一个代码解释器的Session详情。

URI

GET /v1/code-interpreters/{code_interpreter_name}/sessions-get

表1 路径参数

参数

是否必选

参数类型

描述

code_interpreter_name

是

String

参数解释：

与会话关联的代码解释器的唯一标识符。

代码解释器名称获取方式：

1.进入AgentArts平台，在左侧导航栏选择“组件库 > 沙箱工具 ”。

2.在代码解释器列表中“代码解释器名称/ID”处获取代码解释器名称。

约束限制：

不涉及。

取值范围：

需要操作的代码解释器的名称。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-HW-AgentArts-Code-Interpreter-Session-Id

是

String

参数解释：

使用的代码解释器会话的唯一标识符。

约束限制：

必须是使用StartSession命令创建的活动会话。如果会话已过期或已停止，则请求将失败。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

code_interpreter_name

String

参数解释：

代码解释器的名称。

取值范围：

保持和创建代码解释器名称一致。

created_at

String

参数解释：

代码解释器会话创建的时间。

取值范围：

不涉及。

name

String

参数解释：

代码解释器会话的名称。

取值范围：

不涉及。

session_id

String

参数解释：

代码解释器会话的标识符。

取值范围：

不涉及。

session_timeout

Integer

参数解释：

代码解释器会话的超时时间（以秒为单位）。

取值范围：

不涉及。

请求示例

/v1/code-interpreters/123/sessions-get

响应示例

状态码：200

OK

{
  "code_interpreter_name" : "string",
  "session_id" : "string",
  "name" : "string",
  "created_at" : "2026-04-28T10:00:00Z",
  "session_timeout" : 900
}

状态码：400

请求参数错误。

{
  "error_code" : "AgentArts.04010001",
  "error_msg" : "session_id length must be between 1 and 128 characters"
}

状态码：404

资源不存在。

{
  "error_code" : "AgentArts.04010004",
  "error_msg" : "Session session-001 not found"
}

状态码：500

服务内部错误。

{
  "error_code" : "AgentArts.04010000",
  "error_msg" : "Failed to retrieve session"
}

状态码

状态码

描述

200

OK

400

请求参数错误。

404

资源不存在。

500

服务内部错误。

错误码

请参见错误码。

相关文档