# Open API
このドキュメントに記載されている内容は、TA の高度な使用機能に属しており、関連する機能の経験を持つユーザーの参照に適しています。ドキュメントの内容に疑問がある場合は、データコンサルタントに 1 対 1 のサポートを依頼してください。
TA は、強力な UI 分析インターフェイスに加えて、完璧な API を提供します。
- モデルクエリ API:モデルクエリインターフェイスを介してデータを取得します。
- データカスタムクエリ API: SQL によるデータ取得
- ユーザーサブグループとラベル API:主にユーザーサブグループとラベルを構成するために使用されます
- ディメンションテーブル API:ディメンションテーブルの設定に使用されます。
- SQL 文の生成 API:主に SQL 文の生成に使用されます
- 埋め込みポイント管理 API:主に埋め込みポイントデータを管理するため。
- メタデータ管理 API:主にメタデータを管理するため。
- レポート管理 API:主にカンバンレポートデータを管理するため。
- ユーザー管理 API:主にユーザーデータを管理するため。
- プロジェクト管理 API:主にプロジェクトデータを管理するため。
# 呼び出しメソッド
# クエリキーの生成
Open API を使用する必要がある場合は、まずプロジェクトキーを生成する必要があります。プロジェクトキーには 2 種類のキーがあり、キーを生成するコマンドは ta-tool で実行
いずれかの TA サーバーにログインし、su-ta コマンドを実行し、ta ユーザーに切り替え、ta-tool を実行
ルートキーの生成
ta-tool generate_root_secret
- このキーはすべてのプロジェクトに適用できます
個々のプロジェクトのキーを生成します
ta-tool generate_api_secret -appid TEST-APPID
- 渡されたパラメータは対応するプロジェクト APPID で、このキーはそのプロジェクトにのみ適用
注意:同じプロジェクトまたはルートキーを繰り返し生成すると、新しいキーが生成され、以前のキーは無効になります
# API 呼び出しルール
API は、HTTP GET または POST メソッドを使用して呼び出し要求を送信します。
http://$HOST:8992/$API_PATH?token=$API_SECRET
ここで$HOSTは私有化クラスタアドレスで、通常はta2である。$API_PATH は、open/event-analyze などの特定の API パスを表します。$API_SECRET キーです。
API は、GET メソッドまたは POST メソッドで呼び出し要求を送信します。POST 要求メッセージ本体は JSON 形式で、具体的なパラメータ設定は関連ドキュメントを参照してください。
応答メッセージ本体は JSON 形式で、基本構造は以下の通り
{
"return_code": 0,
"return_message": "success",
"data": {...},
"stackMessage": "",
"showStackMessage": false
}
| フィールド | 説明 |
|---|---|
| リターンコード | リターンコード、0は成功、その他は失敗を表す(詳細は下表参照) |
| リターンメッセージ | メッセージに戻る |
| データ | 呼び出し結果データ |
| stackMessage | 失敗時の例外スタック |
| ショースタックメッセージ | TA製品のフロントエンドは、例外スタックのレプリケーションボタン |
return_code リターンコードの詳細
| リターンコード | コード説明に戻る |
|---|---|
| 0 | 成功を実行 |
| -1 | 実行に失敗 |
| -1001 | 未ログイン |
| -10012 | ログイン失敗 |
| -10013 | ログアウト失敗 |
| -1002 | アカウントがロックされているので、管理者に連絡して解決してください |
| -1003 | ユーザー名やパスワードが間違っているので、確認してから再ログインしてください |
| -1004 | システムに問題があるようですが、後で再試行またはお問い合わせください |
| -1005 | リクエスト頻度が速すぎますので、後でお試しください |
| -1006 | 権限なしで操作します |
| -1007 | SSOログイン失敗 |
| -1008 | パラメータエラー |
| -1009 | ユーザー名は存在しません |
| -1010 | 不正操作 |
| -1011 | データはまだ準備ができていない |
| -1012 | 現在のクエリデータなし |
| -1013 | データは準備中です |
| -1014 | 無効なアクセス |
| -1015 | 既に存在する |
| -1020 | 携帯電話番号が間違っている |
| -1021 | メンバーが既にこのプロジェクトで |
| -1022 | リクエストがキャンセルされました |
| -1023 | ターゲットオブジェクトは既に存在しません |
| -1099 | カスタムイベント式が不完全または非合法です |
| -1100 | 作成可能なオブジェクトの数を超える |
| -1999 | 無効なユーザー |
| -2000 | 登録されていないユーザー,登録アクティベーション後に設定が有効になります |
| -2001 | 登録されたユーザーは、次のログイン設定が有効になります |
| -2002 | そのユーザーは、プロジェクトで |
| -2003 | 操作者権限は被操作者の操作権限 |
| -2004 | パラメータが不足しています。管理者に連絡してください |
| -2005 | 操作権限がありません |
| -2006 | データが更新されました |
| -3000 | ライセンス認証に失敗 |
| -3001 | ライセンスチェックに失敗しました。TAカスタマーサービスに連絡して解決してください |
| -3004 | 無効なプロジェクト |
| -3005 | MFA認証失敗、エラーまたは失効したMFA認証コード |
| -3006 | 現在、企業は強制MFA仮想デバイスのログイン認証を開始しています。バインドしてください |
| -3007 | 現在のユーザーはMFA仮想デバイスをバインドしています。バインドを繰り返すことはできません |
| -3008 | 現在のユーザーはMFA仮想デバイスのログインチェックをオンにしており、MFA認証コード |
| -3009 | 操作はサポートされていません |