启动session - StartCodeInterpreterSession
功能介绍
该API用于启动一个代码解释器的Session。
URI
PUT /v1/code-interpreters/{code_interpreter_name}/sessions-start
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| code_interpreter_name | 是 | String | 参数解释: 与会话关联的代码解释器的唯一标识符。 代码解释器名称获取方式: 1.进入AgentArts平台,在左侧导航栏选择“组件库 > 沙箱工具 ”。 2.在代码解释器列表中“代码解释器名称/ID”处获取代码解释器名称。 约束限制: 不涉及。 取值范围: 需要操作的代码解释器的名称。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 是 | String | 参数解释: 代码解释器会话的名称。此名称有助于您识别和管理会话。名称无需唯一。 约束限制: 不涉及。 取值范围: 符合正则条件^[a-zA-Z0-9_-]+$,即仅允许字母、数字、中划线、下划线组成,字符长度必须在1-128个字符之间。 默认取值: 不涉及。 |
| session_timeout | 否 | Integer | 参数解释: 此设置表示会话在无任何活动后自动终止的秒数。 约束限制: 不涉及。 取值范围: 最小允许值为60秒,最大允许值为86400秒(8小时)。 默认取值: 900秒(15分钟) |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code_interpreter_name | String | 参数解释: 代码解释器的名称。 取值范围: 不涉及。 |
| created_at | String | 参数解释: 代码解释器会话创建的时间。 取值范围: 不涉及。 |
| name | String | 参数解释: 代码解释器会话的名称。 取值范围: 不涉及。 |
| session_id | String | 参数解释: 代码解释器会话的标识符。 取值范围: 不涉及。 |
| session_timeout | Integer | 参数解释: 代码解释器会话的超时时间(以秒为单位)。 取值范围: 不涉及。 |
请求示例
/v1/code-interpreters/123/sessions-start
{
"name" : "session-name",
"session_timeout" : 900
} 响应示例
状态码:200
OK
{
"code_interpreter_name" : "string",
"session_id" : "string",
"created_at" : "2026-04-28T10:00:00Z",
"name" : "string",
"session_timeout" : 900
} 状态码:400
请求参数错误。
{
"error_code" : "AgentArts.04010001",
"error_msg" : "body -> name: String should match pattern \"^[a-zA-Z0-9_-]+$\""
} 状态码:409
操作冲突。
{
"error_code" : "AgentArts.04010005",
"error_msg" : "Session session-001 already exists"
} 状态码:429
请求频率超限。
{
"error_code" : "AgentArts.04010006",
"error_msg" : "Session limit reached for container"
} 状态码:500
服务内部错误。
{
"error_code" : "AgentArts.04010000",
"error_msg" : "Jupyter down"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 400 | 请求参数错误。 |
| 409 | 操作冲突。 |
| 429 | 请求频率超限。 |
| 500 | 服务内部错误。 |
错误码
请参见错误码。