更新时间:2026-11-09 GMT+08:00
分享

重置 API Key - ResetCoreSpaceApiKey

功能介绍

异步重置指定 Space 的 API Key,旧 Key 立即失效。若当前处于由 API Key 认证切换至 IAM 认证的“宽限期”,调用本接口会导致原 API Key 立即失效。

调用方法

请参见如何调用API。

授权信息

账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

agentarts:memorySpace:resetCoreSpaceApiKey

Write

memorySpace *

g:ResourceTag/<tag-key>

-

-

URI

POST /v1/core/spaces/{space_id}/reset-key

表1 路径参数

参数

是否必选

参数类型

描述

space_id

是

String

参数解释:

Space ID,唯一标识一个Space,可以通过AgentArts智能体记忆库控制台或者记忆库查询接口获取。

约束限制:

不涉及。

取值范围:

匹配标准的UUID格式(8-4-4-4-12的十六进制数字串,由连字符分隔),符合正则条件^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$。

默认取值:

不涉及。

请求参数

无

响应参数

状态码:202

表2 响应Body参数

参数

参数类型

描述

id

String

参数解释:

异步任务 ID,唯一标识一个异步任务,可通过创建异步任务的接口返回获取。

取值范围:

不涉及。

job_name

String

参数解释:

异步任务名称,标识任务的类型。

取值范围:

  • create_space: 创建记忆库

  • update_network: 更新网络配置

  • import_memories: 记忆导入任务

  • export_memories: 记忆导出任务

status

String

参数解释:

异步任务的当前执行状态。

取值范围:

  • running: 执行中

  • success: 成功

  • failed: 失败

space_id

String

参数解释:

所属 Space ID,标识该记录所属的记忆库。

取值范围:

不涉及。

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

error_msg

String

参数解释:

错误信息。

取值范围:

不涉及。

created_at

String

参数解释:

记录的创建时间,由系统自动生成,格式为 ISO 8601(YYYY-MM-DDTHH:mm:ssZ)。

取值范围:

不涉及。

updated_at

String

参数解释:

记录的最近更新时间,由系统自动更新,格式为 ISO 8601(YYYY-MM-DDTHH:mm:ssZ)。

取值范围:

不涉及。

ext

One of:

参数解释:

任务差异化执行上下文,根据 job_name 不同而结构不同。

job_name为导入任务(import_memories)使用 CoreSpaceImportJobExt,导出任务(export_memories)使用 CoreSpaceExportJobExt,

创建记忆空间(create_space)和更新网络配置(update_network)两个任务不涉及该字段。

取值范围:

不涉及。

key_id

String

参数解释:

API Key ID,可通过“创建 API Key”接口获取。

取值范围:

不涉及。

api_key

String

参数解释:

API Key 明文(仅重置时返回一次,请妥善保存)。

取值范围:

不涉及。

表3 CoreSpaceImportJobExt

参数

参数类型

描述

bucket

String

参数解释:

OBS 桶名(导入来源)。

取值范围:

长度 3-63 字符。

file_path

String

参数解释:

OBS 对象路径(导入文件路径)。

取值范围:

长度 1-1024 字符。

agency_name

String

参数解释:

IAM 委托名称。

取值范围:

长度 1-64 字符。

file_format

String

参数解释:

导入文件格式。

取值范围:

  • jsonl

processed_count

Integer

参数解释:

已处理的记录数。

取值范围:

0 - 2147483647。

success_count

Integer

参数解释:

成功导入的记录数。

取值范围:

0 - 2147483647。

failed_count

Integer

参数解释:

失败导入的记录数。

取值范围:

0 - 2147483647。

total_count

Integer

参数解释:

总记录数。

取值范围:

0 - 2147483647。

errors

Array of errors objects

参数解释:

单条记录级错误列表。

取值范围:

0-100 条。

表4 errors

参数

参数类型

描述

line_number

String

参数解释:

错误记录的行号。

取值范围:

长度 1-20 字符。

error_msg

String

参数解释:

错误描述。

取值范围:

长度 1-1024 字符。

表5 CoreSpaceExportJobExt

参数

参数类型

描述

bucket

String

参数解释:

OBS 桶名(导出目标)。

取值范围:

长度 3-63 字符。

file_path_prefix

String

参数解释:

OBS 对象路径前缀(导出文件目录)。

取值范围:

长度 1-1024 字符。

agency_name

String

参数解释:

IAM 委托名称。

取值范围:

长度 1-64 字符。

file_format

String

参数解释:

导出文件格式。

取值范围:

  • jsonl

file_path

String

参数解释:

导出文件的 OBS 完整路径(obs://bucket/file_path/memories_{job_id}.jsonl)。

取值范围:

长度 1-1024 字符。

total_bytes_written

Long

参数解释:

已写入 OBS 的字节数。

取值范围:

0 - 9223372036854775807。

progress

Integer

参数解释:

导出进度百分比(0-100)。

取值范围:

0-100。

success_count

Integer

参数解释:

成功导出的记录数。

取值范围:

0 - 2147483647。

total_count

Integer

参数解释:

总记录数。

取值范围:

0 - 2147483647。

filters

ExportFilterConditions object

参数解释:

导出过滤条件,所有字段均为可选参数。创建导出的参数和搜索记忆参数保持一致。

表6 ExportFilterConditions

参数

参数类型

描述

actor_id

String

参数解释:

按用户 ID(Actor ID)过滤导出记忆。

取值范围:

长度 1-64

session_id

String

参数解释:

按会话 ID(Session ID)过滤导出记忆。

取值范围:

长度 1-64 字符。

strategy_type

String

参数解释:

按策略类型过滤导出记忆。

取值范围:

  • semantic: 语义记忆

  • summary: 摘要记忆

  • user_preference: 用户偏好

  • episodic: 情景记忆

  • event: 事件记忆

  • custom: 自定义

  • procedural: 过程记忆

start_time

Long

参数解释:

起始时间戳(毫秒),按记忆创建时间过滤。

取值范围:

0-9223372036854775807。

end_time

Long

参数解释:

结束时间戳(毫秒),按记忆创建时间过滤。

取值范围:

0-9223372036854775807。

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码,标识错误类型,格式为 AgentArts.01XXXXXX。

取值范围:

不涉及。

error_msg

String

参数解释:

错误信息,描述错误详情,供问题排查使用。

取值范围:

不涉及。

状态码:401

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码,标识错误类型,格式为 AgentArts.01XXXXXX。

取值范围:

不涉及。

error_msg

String

参数解释:

错误信息,描述错误详情,供问题排查使用。

取值范围:

不涉及。

状态码:403

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码,标识错误类型,格式为 AgentArts.XXXXXXXX。

取值范围:

不涉及。

error_msg

String

参数解释:

错误信息,描述错误详情,供问题排查使用。

取值范围:

不涉及。

encoded_authorization_message

String

参数解释:

编码后的授权失败信息。

取值范围:

不涉及。

details

Array of CoreSpaceCommonError objects

参数解释:

依赖的下游服务错误信息列表,包含导致当前请求失败的下游服务错误详情。

取值范围:

不涉及。

表10 CoreSpaceCommonError

参数

参数类型

描述

error_code

String

参数解释:

错误码,标识错误类型,格式为 AgentArts.01XXXXXX。

取值范围:

不涉及。

error_msg

String

参数解释:

错误信息,描述错误详情,供问题排查使用。

取值范围:

不涉及。

状态码:404

表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码,标识错误类型,格式为 AgentArts.01XXXXXX。

取值范围:

不涉及。

error_msg

String

参数解释:

错误信息,描述错误详情,供问题排查使用。

取值范围:

不涉及。

状态码:429

表12 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码,标识错误类型,格式为 AgentArts.01XXXXXX。

取值范围:

不涉及。

error_msg

String

参数解释:

错误信息,描述错误详情,供问题排查使用。

取值范围:

不涉及。

状态码:500

表13 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码,标识错误类型,格式为 AgentArts.01XXXXXX。

取值范围:

不涉及。

error_msg

String

参数解释:

错误信息,描述错误详情,供问题排查使用。

取值范围:

不涉及。

请求示例

/v1/core/spaces/123e4567-e89b-12d3-a456-426614174000/reset-key

响应示例

无

状态码

状态码

描述

202

API Key 重置请求已接受

400

请求参数错误。

401

认证失败。

403

权限不足。

404

记忆库未找到

429

请求频率超限。

500

内部服务器错误

错误码

请参见错误码。

相关文档