Overview
HTTP呼び出しを行う際に遵守しなければならないAPI仕様は以下のとおりです。データ検索APIは、 Skope ITクエリ言語に基づいています。
Request Parameters
HTTP Method： 得る
| URL Parameter | デスクリプション | 例 |
|---|---|---|
| query | イベントを取得するための高度なフィルター。 | query=access_method+eq+'value'+and+category+like+'abc' |
| フィールド | 結果に値を含めたい列の名前。 | フィールド=アプリ、カテゴリ |
| starttime | イベントの開始時刻を秒単位で示す Unix タイムスタンプ。 | starttime=1641860455 |
| endtime | イベント終了時刻のUnixタイムスタンプ（秒単位）。 | endtime=1641866455 |
| timeout | クエリのタイムアウト時間（秒）。デフォルト: 180 | タイムアウト=180 |
| offset | 結果を表示する前にスキップする行数。 | オフセット=1 |
| limit | 結果として返されるレコードの最大数。 | 制限=20 |
| sublimit | サブ集計を制限するレコードの最大数。 | sublimit=10 |
| groupbys | 集計対象となる項目。 | groupbys=カテゴリ、アプリ |
| subgroupbys | 集計対象となる二次フィールド。 | サブグループ分け=カテゴリ |
| orderbys | イベントを昇順または降順で並べ替えるためのフィールド。 | orderbys=access_method+asc,app+desc |
応答本文
成功時の対応
status.execution == “SUCCESS” の場合、リクエストは成功です。実際に返されたデータについて結果を確認してください。
# JSON
{
"result": [], # slice of json results
"status": {
"execution": "SUCCESS",
"count": 1, # length of results
"message": "Executed Successfully",
"status_code": 200
}
}
エラー応答
status.execution == “FAILED” の場合、リクエストは失敗しました。エラーメッセージを確認してください。
# JSON
{
"result": [], # slice of json results
"status": {
"execution": "FAILED",
"count": 1, # length of results
"message": "Executed Unsuccessfully",
"status_code": non-200 code
}
}
クエリ例
Datasearch エンドポイントはアドホック クエリを目的としており、リクエストでさまざまなパラメータを指定することでシステム内のイベントを取得できるため、このエンドポイントを使用して、ID、時間範囲、その他のメタデータなどの基準に基づいてすべてのイベントや特定のイベントをフィルタリングして取得できます。 いくつか例を挙げます。
- 集計処理を適用することで、アラートイベントをフィルタリングし、指定した期間におけるアラートの総数を表示できます。
Query/api/v2/events/datasearch/alert?starttime=1731535136&endtime=1736805536&fields=count_total:count(id)
Response
{ "result":[ { "count_total":372359 } ], "status":{ "count":1, "execution":"SUCCESS", "message":"Executed Successfully", "status_code":200 } } - また、複数の操作を組み合わせて、一定期間にわたる集計指標を表示することもできます。
Query/api/v2/events/datasearch/page?starttime=0&endtime=0&groupby=user&sortby=server_bytes&fields=sessions=sum(session_number_unique),server_bytes=sum(server_bytes_total),client_bytes=sum(client_bytes_total),numbytes=sum(numbytes_total)
Response
{ "result":[ { "client_bytes":7167685749707, "numbytes":7183668827587, "server_bytes":14567122273, "sessions":9044400340052308025 } ], "status":{ "count":1, "execution":"SUCCESS", "message":"Executed Successfully", "status_code":200 } }