監査ログの公開API

ベースURL

公開監査ログAPIの基本URLは以下の通りです:

https://<DOMAIN_NAME>/api/publishaudit/

認証

公開監査ログAPIにアクセスするには 認証トークンが必要です。トークンを生成できるのはスーパーユーザーだけです。

方法

公開監査ログAPIは情報の取得用であり、GET方式のみをサポートしています。

エンドポイント

公開監査ログAPIには以下のエンドポイントがあります。

終着点

概要

history/<TENANT_NAME>

すべての公開操作の一般的な監査ログをタイムスタンプで降順に並べて返します。 tenant name パラメータは大文字を区別しません。

entityhistory/<TENANT_NAME>/<ENTITY_IDENTIFIER>

エンティティ識別子で特定のエンティティに関連する公開操作を返します。結果はタイムスタンプで降順に並べ替えられます。

entityhistory/<TENANT_NAME>/id/<ENTITY_ID>

特定のエンティティに関連する公開操作をエンティティIDでタイムスタンプで降順に並べて返します。

entitystatus/<TENANT_NAME>/<ENTITY_IDENTIFIER>

特定の事業体の発行状況を返します。

schemahistory/<TENANT_NAME>

スキーマに関連するすべての公開操作をタイムスタンプで降順に返します。

inprogresscount/<TENANT_NAME>

進行中の出版作業数を返します。

entitiesByLastOperationStatus/<TENANT_NAME>/<OPERATION_STATUS>

特定の公開ステータスを持つすべてのエンティティを返します。有効な操作ステータスは、 InProgress、 Success、 Failure、 Cancelledです。

> [!注]
>このエンドポイントは主に失敗または進行中の操作の取得を目的としています。「成功」ステータスのクエリは多くの結果を返すことがあり、パフォーマンスに影響を及ぼしたり、リクエストが失敗したりすることがあります。

performance/snapshot/<TENANT_NAME>

パフォーマンススナップショットを返します。startDateとオプションパラメータを使ってdatetimeの範囲を指定するendDate。指定しない場合、日付はスキップされ、時間は過去15分にデフォルトで表示されます。

performance/queues

すべてのキューとその現在の状態のリストを返します。

オプションのクエリパラメータ

api/publishaudit/history、api/publishaudit/entityhistory、api/publishaudit/schemahistoryにクエリを書く際には、以下のオプションパラメータを含めることができます。

パラメータ

種類

概要

startDate

デートタイム

検索のdatetime範囲の開始点(UTC単位)。これが指定されていない場合、クエリは利用可能なすべての監査エントリーを返します。

endDate

デートタイム

検索のdatetime範囲の終わり(UTC単位)。これが指定されていない場合、クエリは利用可能なすべての監査エントリを返します。

searchAfter

ストリング

次の検索をどこから始めるか、前のクエリで返された searchAfter プロパティ値に基づいています。複数の値はカンマで区切ってください。

take

整数

1回のリクエストで返すべきアイテム数。デフォルト値: 10。

fullText

ストリング

全文検索で使用される用語です。このパラメータに値が与えられた場合、リクエストはその値を含むフィールドの監査エントリのみを返します。

一般的な監査ログ例クエリ

以下のサンプルクエリは、history/ エンドポイントを用いてすべての公開操作の一般的な監査ログを取得します。

クエリ:

GET https:///api/publishAudit/history/CaaS

回答:

{ "items": {...}, {...}, ... , "total": 10000, "searchAfter": "1692293242818,129c39ab-6e3a-4eb2-bb8e-84a2e43e4b32" }

!注応答はスクロールを使用します。 totalプロパティはクエリで返されるアイテム数を示し、上限は10,000です。

次のサンプルでは、takeとsearchAfterオプションパラメータを使って初期クエリを精緻化します。 takeパラメータは3に設定され、searchAfterパラメータで指定されたポイントから始まる3つの結果を返します。

クエリ:

GET https:///api/publishAudit/history/CaaS?searchAfter=1692293242843,7483c2f8-653b-4f77-9ee4-9bed00a23845&take=20

回答:

{ "items": { "delivery_messsage_id": "3667f906-bb0c-4d2e-8cee-45eb75763371", "tenant": "CaaS", "operation": "EntityUpdateACK", "operation_status": "Success", "detailed_description": null, "publish_status": "Published", "is_latest_publish_status": true, "user_name": "Superuser", "operation_attributes": "SkipUserNotification", "skip_notification": true, "id": "78705504-05d9-4bfe-900d-836482ae3a03", "event_type": null, "severity": null, "target_id": 9788, "target_identifier": "M.ContentType.WhitePaper", "timestamp": "2023-08-17T17:`27