删除 Session - DeleteCoreSpaceSession
功能介绍
该接口用于软删除 Session(标记 deleted_at),在需要清理过期或无效的会话时使用。
注意:
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
URI
DELETE /v1/core/spaces/{space_id}/sessions/{session_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| space_id | 是 | String | 参数解释: Space ID是记忆空间的唯一标识,可通过"创建Space"获取。 约束限制: 不涉及。 取值范围: UUID格式。示例:123e4567-e89b-12d3-a456-426614174001。 默认取值: 不涉及。 |
| session_id | 是 | String | 参数解释: Session ID:会话的唯一标识,可通过"创建Session"接口生成或由调用方指定。 约束限制: 不涉及。 取值范围: 长度1-64字符。 默认取值: 不涉及。 |
请求参数
无
响应参数
状态码:204
无
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.XXXXXXXX。 取值范围: 长度18-18字符。 |
| error_msg | String | 参数解释: 错误消息,描述错误详情,供问题排查使用。 取值范围: 长度1-256字符。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.XXXXXXXX。 取值范围: 长度18-18字符。 |
| error_msg | String | 参数解释: 错误消息,描述错误详情,供问题排查使用。 取值范围: 长度1-256字符。 |
| encoded_authorization_message | String | 参数解释: 编码后的授权失败信息。 取值范围: 长度1-4096字符。 |
| details | Array of Error objects | 参数解释: 依赖的下游服务错误信息列表,包含导致当前请求失败的下游服务错误详情。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.XXXXXXXX。 取值范围: 长度18-18字符。 |
| error_msg | String | 参数解释: 错误消息,描述错误详情,供问题排查使用。 取值范围: 长度1-256字符。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.XXXXXXXX。 取值范围: 长度18-18字符。 |
| error_msg | String | 参数解释: 错误消息,描述错误详情,供问题排查使用。 取值范围: 长度1-256字符。 |
状态码:429
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.XXXXXXXX。 取值范围: 长度18-18字符。 |
| error_msg | String | 参数解释: 错误消息,描述错误详情,供问题排查使用。 取值范围: 长度1-256字符。 |
| encoded_authorization_message | String | 参数解释: 编码后的授权失败信息。 取值范围: 长度1-4096字符。 |
| details | Array of Error objects | 参数解释: 依赖的下游服务错误信息列表,包含导致当前请求失败的下游服务错误详情。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.XXXXXXXX。 取值范围: 长度18-18字符。 |
| error_msg | String | 参数解释: 错误消息,描述错误详情,供问题排查使用。 取值范围: 长度1-256字符。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,标识错误类型,格式为 AgentArts.XXXXXXXX。 取值范围: 长度18-18字符。 |
| error_msg | String | 参数解释: 错误消息,描述错误详情,供问题排查使用。 取值范围: 长度1-256字符。 |
请求示例
/v1/core/spaces/123e4567-e89b-12d3-a456-426614174000/sessions/123e4567-e89b-12d3-a456-426614174001
响应示例
状态码:204
无
状态码:401
{
"error_code" : "AgentArts.01020002",
"error_msg" : "Authentication failed"
} 状态码:403
{
"error_code" : "AgentArts.01020003",
"error_msg" : "Insufficient permissions"
} 状态码:404
{
"error_code" : "AgentArts.01020005",
"error_msg" : "Session does not exist"
} 状态码:429
{
"error_code" : "AgentArts.01020008",
"error_msg" : "Too many requests"
} 状态码:500
{
"error_code" : "AgentArts.01020004",
"error_msg" : "Internal service error"
} 状态码
| 状态码 | 描述 |
|---|---|
| 204 | 删除成功 |
| 401 | 认证失败 |
| 403 | 权限不足 |
| 404 | Session 不存在 |
| 429 | 请求过于频繁 |
| 500 | 内部服务错误 |
错误码
请参见错误码。