エンドポイントの監査
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
監査インデックスのクエリに使用できるエンドポイントのリストは、/api/auditにあります。
また、コマンドラインインターフェイス(CLI)と特にtailコマンドを使用して、ログをクエリすることもできます。
クエリ
エンドポイントのベースアドレステンプレートは次のとおりです。
GET /api/audit/<INDEX_NAME>/query{/entityId}{?from,to,fullText,skip,take,sort,order}
クエリエンドポイントは、次のパラメータをサポートします。
|
名前 |
種類 |
サンプル値 |
形容 |
|---|---|---|---|
|
entityId |
長い |
9962 |
監査対象エンティティのID (optional) |
|
from |
日時 |
2018-07-01T08:00Z |
開始日時 |
|
to |
日時 |
2018-07-02T08:00Z |
終了日時 |
|
fullText |
糸 |
資産 |
全文検索フレーズ |
|
skip |
整数 |
0 |
ページング:指定されたアイテムインデックスから開始します |
|
take |
整数 |
10 |
ページング:指定された数のアイテムを表示します |
|
sort |
糸 |
タイムスタンプ |
ソート元のElasticsearchフィールド |
|
order |
糸 |
DESC |
並べ替え順序: ascまたは desc |
{
"items": [
... documents ...
],
"total_items": 15,
"returned_items": 10,
"next": {
"href": "<link to next page>",
"title": ...
},
"previous": {
"href": "<link to previous page>",
"title": ...
},
"self": {
"href": "<link to current page>",
"title": ...
}
}
一部のエンドポイントには、追加のパラメーター セットがあります。対応するセクションでは、相違点を指定します。
アスタリスク (*) は、URLが値のリストを持つキーではなく、キーと値のペアのリストに展開されることを示します。たとえば、Uri.expand("{?userIds*}", {userIds:1,2}) は ?userIds=1,2ではなく ?userIds=1&userIds=2に展開されます。
スクロール
Elasticsearch(ES)クエリで許可されているよりも多くのアイテムをフェッチする必要がある場合は、スクロールAPIを使用する必要があります。これは一方向にのみページングを許可し、エンティティのスクロールエンドポイントと同様に機能します。
エンドポイントのベースアドレステンプレートは次のとおりです。
GET /api/audit/<INDEX_NAME>/scroll{/entityId}{?scrollTime,scrollId,from,to,fullText,skip,take,sort,order}
各スクロール エンドポイントは、対応するクエリ エンドポイントと同じパラメーター セットを受け入れます。
スクロールエンドポイントは、次のパラメータをサポートしています。
|
名前 |
種類 |
サンプル値 |
形容 |
|---|---|---|---|
|
scrollId |
糸 |
DXF1..U1QQ== |
ESによって割り当てられたスクロールID。このパラメータは、レスポンスペイロードのnextリンクに自動的に追加されます。 |
|
scrollTime |
タイムスパン |
生 |
作成されたスクロールがESで存続する時間を決定します。指定しない場合、値は中央集権的な設定のreportingセクション (デフォルトは5000ms) から取得されます。 |
生成する
ログ全体またはそのサブセットのダウンロード注文を行うには、生成エンドポイントを使用します。
エンドポイントのベースアドレステンプレートは次のとおりです。
POST /api/audit/<INDEX_NAME>/generate
生成エンドポイントは、次のパラメーターをサポートします。
|
名前 |
種類 |
サンプル値 |
形容 |
|---|---|---|---|
|
audit_type |
糸 |
生 |
次のいずれかの値: raw、business、scripting、action、または trigger |
|
format |
糸 |
CSVファイル |
次のいずれかの値: csv, json |
|
from |
日時 |
2018-07-01T08:00Z |
開始日時 |
|
to |
日時 |
2018-07-02T08:00Z |
終了日時 |
|
filter |
辞書 |
{ "user_id": "6" } |
選択した監査インデックスに適用された一連のフィルター |
レスポンスヘッダー:
Location: <url to download order>
未加工クエリ
未加工のクエリには、/api/audit/raw/ と /api/audit/raw/operational/の2つのエンドポイントがあります。
ビジネスクエリ
ビジネス・クエリーは、ビジネス監査インデックスをフェッチします。
エンドポイントのベースアドレステンプレートは次のとおりです。
GET /api/audit/business/query{/entityId}{?logType*,raw,from,to,fullText,skip,take,sort,order}
ビジネスクエリエンドポイントは、次のパラメータをサポートします。
|
名前 |
種類 |
サンプル値 |
形容 |
|---|---|---|---|
|
logType |
糸 |
ユーザー監査 |
指定されたタイプによるフィルタリング |
|
eventTypes |
糸 |
user.login.success(ログイン成功) |
イベントの種類。取り得る値: Created、Updated、Deleted、Enabled、Disabled、またはExecuted。 |
|
createdBy |
糸 |
サンプルユーザー |
ビジネス エンティティを作成したユーザー |
|
modifiesBy |
糸 |
サンプルユーザー |
ビジネスエンティティを最後に変更したユーザー |
|
username |
糸 |
サンプルユーザー |
クエリを行うユーザー |
|
definition |
糸 |
事業体の定義 | |
|
raw |
糸 |
生のElasticsearchクエリ(deprecated:互換性のために残されたパラメータ) |
GET /api/audit/business/query?logType*==useraudit
{
"items": [
{
"event_type": "user.login.success",
"created_by": "SampleUser",
"modified_by": "SampleUser",
"created_on": "2018-11-29T13:36:11.7964771Z",
"modified_on": "2021-04-19T09:45:25.1231815Z",
"username": "SampleUser",
"log_type": "useraudit",
"browser_information": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.72 Safari/537.36",
"geoip": {
"continent_name": "Europe",
"region_iso_code": "BE-VBR",
"city_name": "Halle",
"country_iso_code": "BE",
"region_name": "Flemish Brabant Province",
"location": {
"lon": 4.2345,
"lat": 50.7338
}
}
},
...]
}
ビジネスジェネレーション
ビジネス生成エンドポイントは、次のパラメーターをサポートします。
|
名前 |
種類 |
サンプル値 |
形容 |
|---|---|---|---|
|
log_type |
糸 |
ユーザー監査 |
filterプロパティをオーバーライドして、指定されたログの種類をフィルターとして設定します。 |
スクリプティングクエリ
スクリプト クエリは、スクリプト監査インデックスをフェッチしました。
エンドポイントのベースアドレステンプレートは次のとおりです。
GET /api/audit/scripting/query{/entityId}{?scriptType,scriptName,scriptContentId,scriptContentIdentifier,errorMessage,executionSource,id,eventType,severity,targetId,targetIdentifier,userId,from,to,fullText,skip,take,sort,order}
スクリプトクエリエンドポイントは、次のパラメータをサポートしています。
|
名前 |
種類 |
サンプル値 |
形容 |
|---|---|---|---|
|
scriptType |
糸 |
ユーザー事前登録 |
スクリプトのタイプ。取り得る値: UserPreRegistration、UserPostRegistration、UserSignIn、MetadataProcessing、またはActionScript。 |
|
scriptName |
糸 |
fooスクリプト |
スクリプト名 |
|
scriptContentId |
長い |
1234 |
スクリプトコンテンツエンティティのID |
|
scriptContentIdentifier |
糸 |
zfSGGTUNhkKVdY9U-z49iQ |
スクリプトコンテンツエンティティの識別子 |
|
errorMessage |
糸 |
失敗 しました |
エラー メッセージのフラグメント |
|
executionSource |
糸 |
自動 |
スクリプト実行ソース。取り得る値: Automatic、Trigger、WebApi、Command、ExternalAction、またはMassEdit。 |
|
id |
グイド |
0CCD58CF-C83F-42BA-907F-44D8950A20FD |
監査メッセージID |
|
eventType |
糸 |
作成 |
イベントの種類。取り得る値: Created、Updated、Deleted、Enabled、Disabled、またはExecuted。 |
|
severity |
糸 |
警告 |
監査エントリの重大度。取り得る値: Debug、Warning、Info、Error、またはFatal。 |
|
targetId |
長い |
1234 |
監査対象エンティティのID |
|
targetIdentifier |
糸 |
zfSGGTUNhkKVdY9U-z49iQ |
監査対象エンティティの識別子 |
|
userId |
長い |
1234 |
監査エントリの作成をトリガーしたユーザーのID |
GET /api/audit/scripting/query?scriptType==UserPreRegistration
{
"items": [
{
"script_type": "ActionScript",
"script_name": "CMP - Create public links for linked assets",
"script_content_id": 30459,
"script_content_identifier": "gqQwt42TR0-H053IJPX5KQ",
"execution_time": 2343,
"execution_source": "Trigger",
"context_data": {
"data": {},
"execution_event": null,
"execution_phase": null,
"execution_source": "Trigger",
"execution_type": "OutOfProcess",
"result": {},
"target": "Asset",
"target_id": 31523,
"target_type": null
}
},
...]
}
}
アクション クエリ
アクション問合せは、アクション監査インデックスをフェッチします。
エンドポイントのベースアドレステンプレートは次のとおりです。
GET /api/audit/action/query{/entityId}{?actionType,actionPhase,executionType,executionSource,executionTime,messageId,retryCount,success,id,eventType,severity,targetId,targetIdentifier,userId,from,to,fullText,skip,take,sort,order}
アクションクエリエンドポイントは、次のパラメータをサポートします。
|
名前 |
種類 |
サンプル値 |
形容 |
|---|---|---|---|
|
actionType |
糸 |
アピコール |
アクションの種類。取り得る値: ApiCall、ActionScript、AzureEventHub、ReportingChannel、PrintEntityGeneration、StartBpmAutomation、StartSmAutomation、AzureServiceBus、またはMAzureServiceBus。 |
|
actionPhase |
糸 |
前 |
アクションが実行されるフェーズ。可能な値: Post、Pre、Security、Validation、Audit。 |
|
executionType |
糸 |
インプロセス |
実行のタイプ。可能な値: OutOfProcessまたはInProcess。 |
|
executionSource |
糸 |
トリガー |
実行のソース。取り得る値: Unknown、Trigger、ExternalAction、Command、WebApi、MassEdit、またはBPM。 |
|
executionTime |
長い |
234 |
経過した実行時間 (ミリ秒) |
|
messageId |
長い |
1234 |
メッセージID |
|
retryCount |
整数 |
3 |
再試行回数 |
|
success |
ブール |
真 |
アクションが成功したかどうか |
|
id |
グイド |
0CCD58CF-C83F-42BA-907F-44D8950A20FD |
監査メッセージID |
|
eventType |
糸 |
作成 |
イベントの種類。取り得る値: Created、Updated、Deleted、Enabled、Disabled、またはExecuted。 |
|
severity |
糸 |
警告 |
監査エントリの重大度。取り得る値: Debug、Warning、Info、Error、またはFatal。 |
|
targetId |
長い |
1234 |
監査対象エンティティのID |
|
targetIdentifier |
糸 |
zfSGGTUNhkKVdY9U-z49iQ |
監査対象エンティティの識別子 |
|
userId |
長い |
1234 |
監査エントリの作成をトリガーしたユーザーのID |
GET /api/audit/action/query?actiontype==ApiCall
{
"items": [
{
"action_type": "StartSmAutomation",
"action_phase": "Post",
"execution_type": "InProcess",
"execution_source": "Trigger",
"execution_time": 8,
"target_name": "CMP - Content approval action",
"retry_count": 0,
"success": true,
"entity_id": 33232,
"id": "42e0ca85-87d1-437b-9df8-3decbadd1bf8",
"audit_type": "Action",
"event_type": "Executed",
"severity": "Info",
"target_id": 9878,
"target_identifier": "M.Action.CMP.Content.Approval",
"timestamp": "2021-04-19T10:42:09.8503118Z",
"user_id": 6
},
...]
}