跳到主要内容

Open API

最近更新 2026/10/03

本文档所描述的内容属于 AE 的高级使用功能，涉及较多技术细节，适用于对相关功能有经验的用户参考。如果对文档内容有疑惑，请咨询您的数据咨询顾问获取一对一的协助。

AE 除了强大的 UI 分析界面，还提供了完善的 API。

调用方法​

生成查询密钥​

如果需要使用 Open API，首先需要生成项目密钥。项目密钥共有两种密钥，生成密钥的命令需要在 ta-tool 中执行

登录到任意一台 AE 服务器，执行su - ta命令，切换至 ta 用户，执行ta-tool

生成 root 密钥

ta-tool generate_root_secret
  • 该密钥可适用于所有项目

生成单个项目的密钥

ta-tool generate_api_secret -appid TEST-APPID
  • 传入的参数为对应的项目 APPID，该密钥只能适用于该项目
  • 特殊情况：使用单个项目的密钥调用数据自定义查询API时，默认可查所有项目的数据，如需限制请联系 ThinkingAI 工作人员

注意：当重复执行生成同一项目或 root 密钥，会生成新的密钥，而之前的密钥将会失效

API 调用规则​

API 以HTTP GET 或者 POST 方法提交调用请求，调用的 URL 为:

http://$HOST:28992/$API_PATH?token=$API_SECRET

其中$HOST为私有化集群地址，通常为ta1，默认仅支持内网调用。$API_PATH 则表示具体的 API路径，比如open/event-analyze。$API_SECRET 为密钥。

API 以GET方法或 POST 方法提交调用请求。 POST请求消息体为 JSON 格式，具体参数配置请查阅相关文档。

响应消息体为 JSON 格式, 基本结构如下

{
  "return_code": 0,
  "return_message": "success",
  "data": {...},
  "stackMessage": "",
  "showStackMessage": false
}
字段描述
return_code返回代码，0表示成功，其他表示失败（详细说明见下表）
return_message返回消息
data调用结果数据
stackMessage失败时的异常栈
showStackMessageAE 产品前端使用（OpenAPI调用可忽略该字段），表示应否展示异常栈的复制按钮

return_code 返回代码详细说明

返回代码返回代码说明
0执行成功
-1执行失败
-1001未登录
-10012登录失败
-10013登出失败
-1002您账号已被锁定，请联系管理员解决
-1003用户名或密码错误，请确认后重新登录
-1004系统似乎出现了一些问题，请稍后重试或联系我们
-1005请求频率过快，请稍后再试
-1006您无权限操作
-1007SSO登录失败
-1008参数错误
-1009用户名不存在
-1010非法操作
-1011数据尚未准备好
-1012当前查询无数据
-1013数据正在准备
-1014无效的访问
-1015已存在
-1020手机号有误
-1021有成员已在此项目中
-1022请求被取消
-1023目标对象已不存在
-1099自定义事件表达式不完整或不合法
-1100超出可创建对象的数量
-1999无效用户
-2000未注册用户,注册激活后设置生效
-2001已注册用户,激活后下次登录设置生效
-2002该用户已在项目中
-2003操作者权限不能低于被操作者的操作权限
-2004参数缺失, 请联系管理员
-2005您不具备该操作权限
-2006数据已被更新过
-3000许可证认证失败
-3001license校验失败，请联系 ThinkingAI 客服人员解决
-3004无效项目
-3005MFA验证失败,错误或过期的MFA验证码
-3006当前企业已开启强制MFA虚拟设备登陆验证，请绑定
-3007当前用户已绑定MFA虚拟设备,无法重复绑定
-3008当前用户已开启MFA虚拟设备登陆校验,缺少MFA验证码
-3009操作不被支持
这篇文档对你有帮助吗？
本页内容