停止session - StopCodeInterpreterSession
功能介绍
该API用于停止指定的代码解释器的Session。
调用方法
请参见如何调用API。
授权信息
当前API调用无需身份策略权限。
URI
PUT /v1/code-interpreters/{code_interpreter_name}/sessions-stop
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| code_interpreter_name | 是 | String | 参数解释: 与会话关联的代码解释器的唯一标识符。 代码解释器名称获取方式: 1.进入AgentArts平台,在左侧导航栏选择"组件库 > 沙箱工具 "。 2.在代码解释器列表中"代码解释器名称/ID"处获取代码解释器名称。 约束限制: 必须为已创建的代码解释器名称,若不存在则返回404错误。 取值范围: 符合正则^[a-z][a-z0-9-]{0,46}[a-z0-9]$,即必须以小写字母开头,小写字母或数字结尾,中间可包含数字、小写字母、中划线,字符长度必须在2-40个字符之间。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-HW-AgentArts-Code-Interpreter-Session-Id | 是 | String | 参数解释: 使用的代码解释器会话的唯一标识符。 约束限制: 必须为StartCodeInterpreterSession接口返回的活动会话ID。session_id不可为空,格式不合法返回400错误,会话不存在或已过期返回404错误。 取值范围: 由StartCodeInterpreterSession接口返回的session_id,长度1-128字符。 默认取值: 不涉及。 |
| Authorization | 是 | String | 参数解释: 本次智能体工具调用对应的身份认证凭据。需要根据实际的智能体工具的入站身份认证方式获取对应的身份认证凭据。 API Key认证、IAM认证及OAuth 2.0认证具体请参见认证鉴权。 约束限制: 不涉及。 取值范围: 不超过4096位字符。 默认取值: 不涉及。 |
响应参数
状态码:204
No Content
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | Integer | 参数解释: 异常错误码。 取值范围: 不涉及。 |
| message | String | 参数解释: 错误详细信息。 取值范围: 长度为 1 - 512 个字符。 |
请求示例
/v1/code-interpreters/123/sessions-stop
响应示例
状态码:400
请求参数错误。
{
"error_code" : "AgentArts.04010001",
"error_msg" : "'x-hw-agentarts-code-interpreter-session-id' header is required"
} 状态码:404
资源不存在。
{
"error_code" : "AgentArts.04010004",
"error_msg" : "Session session-001 not found"
} 状态码:500
服务内部错误。
{
"error_code" : "AgentArts.04010000",
"error_msg" : "Failed to stop session"
} 状态码
| 状态码 | 描述 |
|---|---|
| 204 | No Content |
| 400 | 请求参数错误。 |
| 401 | 未授权(认证令牌缺失、无效或已过期)。 |
| 404 | 资源不存在。 |
| 500 | 服务内部错误。 |
错误码
请参见错误码。