文档中心

ArkClaw 企业版

API 参考

API 列表

API 列表

ArkClaw 企业版提供以下 OpenAPI 接口。

Claw 空间（ClawSpace）

API名称	功能
ListClawSpaces	批量查询 ArkClaw 空间详情。
UpdateUsersModelConfig	批量更新用户模型配置，支持配置模型的每日、每分钟 Token 限流，绑定、解绑用户的 CodingPlan 的席位。
GetClawSpace	获取 ArkClaw 空间详情。
ListUsersModelConfig	通过自定义筛选条件批量查询用户模型配置详情。

模板（Template）

API名称	功能
CreateSpaceTemplate	创建一个自定义 Claw 模板。
GetSpaceTemplateUserBindings	获取自定义 Claw 模板用户绑定详情。
BindSpaceTemplateUsers	为指定用户派发自定义 Claw 模板，派发后该用户可使用该模板创建 ArkClaw 实例。
UnbindSpaceTemplateUsers	将指定用户从自定义 Claw 模板的派发列表中移除，移除后该用户新创建的 ArkClaw 实例将不受此模板限制。
UpdateSpaceTemplate	更新一个自定义 Claw 模板。
ListSpaceTemplateUserBindings	批量查询指定空间内用户与自定义 Claw 模板的绑定详情，支持按用户 ID 或自定义 Claw 模板ID筛选。
GetSpaceTemplate	获取自定义 Claw 模板详情。
ListSpaceTemplates	通过自定义筛选条件批量查询指定空间下的自定义 Claw 模板详情。
DeleteSpaceTemplate	删除一个自定义 Claw 模板。

Claw 实例（ClawInstance）

API名称	功能
CreateClawInstance	创建一个 ArkClaw 实例。
StartClawInstance	启动一个 ArkClaw 实例。
UpdateClawInstance	更新一个 ArkClaw 实例。
StopClawInstance	停止一个 ArkClaw 实例。
DeleteClawInstance	删除一个 ArkClaw 实例。
DeleteClawInstances	批量删除 ArkClaw 实例。
ResetClawInstance	重置一个 ArkClaw 实例，将其配置和运行环境重新初始化，通常用于修复 Claw 服务崩溃或解决系统异常。
GetClawInstance	获取 ArkClaw 实例详情。
ListClawInstances	通过自定义筛选条件批量查询 ArkClaw 实例详情。
GetClawInstanceTerminalToken	获取访问 ArkClaw 实例终端所需的临时鉴权凭据，获取后可建立与实例终端的交互式连接，进行命令行操作。
GetClawInstanceChatToken	获取访问 ArkClaw 实例的临时会话凭据，供后续通过 WebSocket（wss）协议与实例建立实时连接时使用。
UpdateClawInstanceModel	更新 ArkClaw 实例使用的模型，仅支持更新状态为“运行中”的实例。
UpdateClawInstanceChannel	更新 ArkClaw 实例的消息渠道。
CreateClawInstanceSnapshot	批量创建 ArkClaw 实例备份。
GetClawInstanceSnapshot	获取 ArkClaw 实例备份详情。
ListClawInstanceSnapshots	通过自定义筛选条件批量查询 ArkClaw 实例备份记录详情。
DeleteClawInstanceSnapshot	删除一个 ArkClaw 实例备份记录。
RestoreClawInstanceSnapshot	基于指定备份记录恢复单个 ArkClaw 实例。

镜像（Image）

API名称	功能
CreateClawImage	创建一个 ArkClaw 自定义镜像。
CreateClawImageFromYaml	基于 YAML 创建 ArkClaw 自定义镜像。
GetClawImage	获取 ArkClaw 镜像详情。
GetBaseImageManifest	获取公共镜像详情。
ListClawImages	通过自定义筛选条件批量查询 ArkClaw 镜像详情。
UpdateClawImage	更新 ArkClaw 自定义镜像信息。
DeleteClawImage	删除一个 ArkClaw 自定义镜像。

用户管理（UserManagement）

API名称	功能
CreateUser	创建一个用户。
CreateUsers	批量创建用户。
ListUsers	批量查询用户详情。
UpdateUser	更新用户信息。
DeleteUser	删除一个用户。
CreateDepartment	创建一个部门。
GetDepartment	获取部门详情。
GetDepartmentTree	获取部门树详情。
ListDepartments	批量查询部门详情。
UpdateDepartment	更新部门信息。
AddUsersToDepartment	添加部门成员。
RemoveUsersFromDepartment	移除部门成员。
DeleteDepartment	删除一个部门。

用户席位配额（UserSeatQuota）

API名称	功能
UpdateUserSeatQuotas	批量更新用户级席位配额。
GetUserSeatQuota	查询单个用户在指定空间下的全部席位配额。
ListUserSeatQuotas	批量查询用户席位配额详情。
ListUserSeatUsages	批量查询用户席位使用详情，包括席位类型等信息，帮助管理员掌握空间内的席位分配与使用概览。

标签（Tag）

API名称	功能
TagResources	为 ArkClaw 实例添加自定义标签。
UntagResources	删除 ArkClaw 实例自定义标签。

指标查询

API名称	功能
Draw	查询指标的详细信息。说明若存在自定义查询指标需求，可参考 ArkClaw 企业版指标说明、查询 ArkClaw 企业版指标。

Trace 分析

API名称	功能
GetTraceTrend	获取 Span 上报量趋势。
GetTraceDetail	获取 Trace 详情。
ListSpan	获取 Span 列表。

最近更新时间：2026.10.23 10:26:10

这个页面对您有帮助吗？

有用

有用

无用

无用