停止智能体运行时会话 - StopRuntimeSession
功能介绍
该接口用于根据会话唯一标识对智能体运行时的会话进行销毁操作。
适用场景:
使用智能体运行时(高代码)接口创建会话后,需要将会话对应的实例进行停止的场景。
URI
POST /agent/{agent_name}/sessions-stop
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Hw-Agentarts-Session-Id | 是 | String | 参数解释: 会话ID,每个会话的唯一标识符。用户可将会话ID设置为任意字符串,例如“123e4567e89b12d3a456426614174000”,无需在其他地方获取。 约束限制: 不涉及。 取值范围: 由英文,数字,“-”,“_”组成,不超过64位字符。 默认取值: 不涉及。 |
| Authorization | 是 | String | 参数解释: 本次智能体运行时调用对应的身份认证凭据。需要根据实际的智能体运行时的入站身份认证方式获取对应的身份认证凭据。 API Key认证、IAM认证及OAuth 2.0认证具体请参见认证鉴权。 约束限制: 不涉及。 取值范围: 不超过4096位字符。 默认取值: 不涉及。 |
| X-Sdk-Content-Sha256 | 否 | String | 参数解释: 如果智能体运行时的入站认证类型为IAM认证时,需要指定该Header头为UNSIGNED-PAYLOAD。 约束限制: 不涉及。 取值范围: 固定为UNSIGNED-PAYLOAD。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | Integer | 参数解释: 停止会话成功的状态码,固定为200。 取值范围: 不涉及。 |
| message | String | 参数解释: 智能体运行时会话停止成功的详细信息。 取值范围: 长度为 1 - 512 个字符。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | Integer | 参数解释: 异常错误码。 取值范围: 不涉及。 |
| message | String | 参数解释: 错误详细信息。 取值范围: 长度为 1 - 512 个字符。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | Integer | 参数解释: 异常错误码。 取值范围: 不涉及。 |
| message | String | 参数解释: 错误详细信息。 取值范围: 长度为 1 - 512 个字符。 |
请求示例
POST https://{Endpoint}/agent/{agent_name}/sessions-stop 响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 停止成功, 返回相关信息。 |
| 401 | 未授权(认证令牌缺失、无效或已过期)。 |
| 500 | 服务器内部错误。 |
错误码
请参见错误码。