監査エンドポイント
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
監査インデックスのクエリに使用できるエンドポイントのリストは、/api/audit にあります。
またログのクエリには、コマンド ライン インターフェイス (CLI)、特にテール コマンドを使用できます。
クエリ
クエリ
エンドポイントのベース アドレス テンプレートは次のとおりです。
エンドポイントのクエリには、次のパラメーターがサポートされています。
| 名前 | 型 | サンプル値 | 説明 |
|---|---|---|---|
entityId | Long | 9962 | 監査対象エンティティの ID (任意) |
from | DateTime | 2018-07-01T08:00Z | 開始日時 |
to | DateTime | 2018-07-02T08:00Z | 終了日時 |
fullText | String | アセット | 全文検索のフレーズ |
skip | Int | 0 | ページング: 指定したアイテム インデックスを起点とします |
take | Int | 10 | ページング: 指定した数のアイテムを表示します |
sort | String | timeStamp | 並べ替えを始める Elasticsearch フィールド |
order | String | desc | 並べ替え順序: asc または desc |
応答の例:
一部のエンドポイントには、追加のパラメーター セットが用意されています。違いについては、対応する各セクションで示します。
アスタリスク (*) は、URL が値のリストを持つキーではなく、キーと値のペアのリストに展開されることを示します。
例:
?userIds=1,2 ではなく ?userIds=1&userIds=2 に展開されます。
スクロール
スクロール
Elasticsearch (ES) クエリで許容される数よりも多くのアイテムをフェッチする必要がある場合は、スクロール API を使用する必要があります。ページングは一方向にのみ可能で、エンティティのスクロール エンドポイントと同様に機能します。
エンドポイントのベース アドレス テンプレートは次のとおりです。
各スクロール エンドポイントは、対応するクエリ エンドポイントと同じパラメーター セットを受け入れます。
スクロール エンドポイントでは、次のパラメーターがサポートされています。
| 名前 | 型 | サンプル値 | 説明 |
|---|---|---|---|
scrollId | String | DXF1..U1QQ== | ES によって割り当てられたスクロール ID。このパラメーターは、応答ペイロードの next リンクに自動的に追加されます。 |
scrollTime | TimeSpan | Raw | 作成されたスクロールを ES で存続させる期間を決定します。指定されていない場合、値は一元化された設定の reporting セクションから取得されます (既定は 5000 ミリ秒)。 |
生成
生成
ログ全体またはそのサブセットのダウンロードを指示するために、生成エンドポイントを使用します。
エンドポイントのベース アドレス テンプレートは次のとおりです。
生成エンドポイントでは、次のパラメーターがサポートされています。
| 名前 | 型 | サンプル値 | 説明 |
|---|---|---|---|
audit_type | String | Raw | raw、business、scripting、action、trigger のいずれかの値 |
format | String | csv | csv、json のいずれかの値 |
from | DateTime | 2018-07-01T08:00Z | 開始日時 |
to | DateTime | 2018-07-02T08:00Z | 終了日時 |
filter | Dict | { "user_id": ["6"] } | 選択した監査インデックスに適用される一連のフィルター |
応答ヘッダー:
未処理のクエリ
未処理のクエリ
未処理のクエリは、プロパティやリレーションの変更など、エンティティを含む未処理の監査インデックスをフェッチします。
エンドポイントのベース アドレス テンプレートは次のとおりです。
未処理のクエリ エンドポイントでは、次のパラメーターがサポートされています。
| 名前 | 型 | サンプル値 | 説明 |
|---|---|---|---|
eventTypes | String | EntityUpdated | 監査対象のイベントのタイプ |
definitionNames | String | M.Asset | エンティティの定義名 |
userIds | Long | 1211 | ユーザー ID |
properties | String | Title | 指定したプロパティに対して行われた変更を基準としたフィルタリング |
relations | String | AssetToAssetMedia | 指定したリレーションに対して行われた変更を基準としたフィルタリング |
culture | String | en-US | 応答データのカルチャ |
要求の例:
応答の例:
ビジネス クエリ
ビジネス クエリ
ビジネス クエリは、ビジネス監査インデックスをフェッチします。
エンドポイントのベース アドレス テンプレートは次のとおりです。
ビジネス クエリ エンドポイントでは、次のパラメーターがサポートされています。
| 名前 | 型 | サンプル値 | 説明 |
|---|---|---|---|
logType | String | useraudit | 指定したタイプを基準としたフィルタリング |
eventTypes | String | user.login.success | イベント タイプ。可能な値: Created、Updated、Deleted、Enabled、Disabled、Executed |
createdBy | String | SampleUser | ビジネス エンティティを作成したユーザー |
modifiesBy | String | SampleUser | ビジネス エンティティを最後に変更したユーザー |
username | String | SampleUser | クエリを作成しているユーザー |
definition | String | ビジネス エンティティの定義 | |
raw | String | 未処理の Elasticsearch 検索クエリ (非推奨: 互換性のために残されたパラメーター) |
要求の例:
応答の例:
ビジネス生成
ビジネス生成
ビジネス生成エンドポイントでは、次のパラメーターがサポートされています。
| 名前 | 型 | サンプル値 | 説明 |
|---|---|---|---|
log_type | String | useraudit | フィルター プロパティを上書きして、指定したログ タイプをフィルターとして設定します。 |
スクリプト クエリ
スクリプト クエリ
スクリプト クエリは、スクリプト監査インデックスをフェッチします。
エンドポイントのベース アドレス テンプレートは次のとおりです。
スクリプト エンドポイントでは、次のパラメーターがサポートされています。
| 名前 | 型 | サンプル値 | 説明 |
|---|---|---|---|
scriptType | String | UserPreRegistration | スクリプトのタイプ。可能な値: UserPreRegistration、UserPostRegistration、UserSignIn、MetadataProcessing、ActionScript |
scriptName | String | fooScript | スクリプト名 |
scriptContentId | Long | 1234 | スクリプト コンテンツ エンティティの ID |
scriptContentIdentifier | String | zfSGGTUNhkKVdY9U-z49iQ | スクリプト コンテンツ エンティティの ID |
errorMessage | String | 失敗 | エラー メッセージのフラグメント |
executionSource | String | Automatic | スクリプトの実行ソース。可能な値: Automatic、Trigger、WebApi、Command、ExternalAction、MassEdit |
id | Guid | 0ccd58cf-c83f-42ba-907f-44d8950a20fd | 監査メッセージの ID |
eventType | String | Created | イベント タイプ。可能な値: Created、Updated、Deleted、Enabled、Disabled、Executed |
severity | String | 警告 | 監査エントリの重大度。可能な値: Debug、Warning、Info、Error、Fatal |
targetId | Long | 1234 | 監査対象エンティティの ID |
targetIdentifier | String | zfSGGTUNhkKVdY9U-z49iQ | 監査対象エンティティの ID |
userId | Long | 1234 | 監査エントリの作成をトリガーしたユーザーの ID |
要求の例:
応答の例:
アクション クエリ
アクション クエリ
アクション クエリは、アクション監査インデックスをフェッチします。
エンドポイントのベース アドレス テンプレートは次のとおりです。
アクション クエリ エンドポイントでは、次のパラメーターがサポートされています。
| 名前 | 型 | サンプル値 | 説明 |
|---|---|---|---|
actionType | String | ApiCall | アクションのタイプ。可能な値: ApiCall、ActionScript、AzureEventHub、ReportingChannel、PrintEntityGeneration、StartBpmAutomation、StartSmAutomation、AzureServiceBus、MAzureServiceBus |
actionPhase | string | Pre | アクションが実行されるフェーズ。可能な値: Post、Pre、Security、Validation、Audit |
executionType | string | InProcess | 実行のタイプ。可能な値: OutOfProcess、InProcess |
executionSource | string | Trigger | 実行ソース。可能な値: Unknown、Trigger、ExternalAction、Command、WebApi、MassEdit、BPM |
executionTime | Long | 234 | ミリ秒単位の経過実行時間 |
messageId | Long | 1234 | メッセージ ID |
retryCount | Int | 3 | 再試行回数 |
success | ブール値 | true | アクションが正常だったかどうか |
id | Guid | 0ccd58cf-c83f-42ba-907f-44d8950a20fd | 監査メッセージの ID |
eventType | string | Created | イベント タイプ。可能な値: Created、Updated、Deleted、Enabled、Disabled、Executed |
severity | string | 警告 | 監査エントリの重大度。可能な値: Debug、Warning、Info、Error、Fatal |
targetId | Long | 1234 | 監査対象エンティティの ID |
targetIdentifier | string | zfSGGTUNhkKVdY9U-z49iQ | 監査対象エンティティの ID |
userId | Long | 1234 | 監査エントリの作成をトリガーしたユーザーの ID |
要求の例:
応答の例: