メインコンテンツまでスキップ

Open API

最終更新 2026/10/03

このドキュメントで説明する内容はAEの高度な機能に属し、技術的な詳細を多く含むため、関連機能の使用経験があるユーザー向けの参考資料です。ドキュメントの内容についてご不明な点がある場合は、担当のデータコンサルタントにお問い合わせのうえ、個別のサポートを受けてください。

AEは、強力なUI分析画面に加えて、充実したAPIも提供しています。

呼び出し方法​

クエリキーの生成​

Open APIを使用するには、まずプロジェクトキーを生成する必要があります。プロジェクトキーには2種類あり、キーを生成するコマンドは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この操作はサポートされていません
このページは役に立ちましたか？
このページの内容