# Open API

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

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

# 调用方法

# 生成查询密钥

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

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

生成 root 密钥

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

生成单个项目的密钥

ta-tool generate_api_secret -appid TEST-APPID
  • 传入的参数为对应的项目 APPID,该密钥只能适用于该项目

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

# API 调用规则

其余 API 以 POST 方式提交调用请求,调用的 URL 为:

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

其中$HOST为私有化集群地址,$API_PATH 则表示具体的 API,$API_SECRET 为密钥

参数为 JSON 格式,具体参数配置请查阅相关文档