監査ログAPIの公開

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

パブリッシング監査ログAPIを使用すると、Sitecore Content Hub環境内のすべてのパブリッシング操作 (エンティティの更新や削除、スキーマの変更など) を追跡できます。各操作には、開始時と成功または失敗時の2つの監査レコードがあります。

ベースURL

公開監査ログAPIのベースURLは次のとおりです。

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

認証

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

メソッド

公開監査ログAPIは情報を取得するためのものであるため、GET方式のみをサポートします。

エンドポイント

発行監査ログAPIには、次のエンドポイントがあります。

エンドポイント	形容
history/{:placeholder-token:}<TENANT_NAME>{/:placeholder-token:}	すべてのパブリッシング操作の一般的な監査ログを、タイムスタンプの降順でソートして返します。 tenant nameパラメーターでは、大文字と小文字は区別されません。
entityhistory/{:placeholder-token:}<TENANT_NAME>{/:placeholder-token:}/{:placeholder-token:}<ENTITY_IDENTIFIER>{/:placeholder-token:}	特定のエンティティに関連する公開操作をエンティティ識別子で返します。結果は、タイムスタンプで降順にソートされます。
entityhistory/{:placeholder-token:}<TENANT_NAME>{/:placeholder-token:}/id/{:placeholder-token:}<ENTITY_ID>{/:placeholder-token:}	特定のエンティティに関連する発行操作をエンティティIDで返し、タイムスタンプで降順に並べ替えます。
entitystatus/{:placeholder-token:}<TENANT_NAME>{/:placeholder-token:}/{:placeholder-token:}<ENTITY_IDENTIFIER>{/:placeholder-token:}	特定のエンティティのエンティティの公開ステータスを返します。
schemahistory/{:placeholder-token:}<TENANT_NAME>{/:placeholder-token:}	スキーマに関連するすべての公開操作を、タイムスタンプの降順で返します。
inprogresscount/{:placeholder-token:}<TENANT_NAME>{/:placeholder-token:}	まだ進行中の公開操作の数を返します。
entitiesByLastOperationStatus/<TENANT_NAME>/<OPERATION_STATUS>	特定の公開状態を持つすべてのエンティティを返します。有効な操作ステータスは、InProgress、Success、Failure、およびCancelledです。メモこのエンドポイントは、主に失敗した操作または進行中の操作を取得するためのものです。「成功」ステータスをクエリすると、多くの結果が返される可能性があり、パフォーマンスに影響を与えたり、リクエストが失敗したりする可能性があります。
performance/snapshot/{:placeholder-token:}<TENANT_NAME>{/:placeholder-token:}	パフォーマンスのスナップショットを返します。 startDateとendDateの省略可能なパラメーターを使用して、datetime範囲を指定します。指定しない場合、日付はスキップされ、時刻はデフォルトで過去15分になります。
performance/queues	すべてのキューとその現在の状態の一覧を返します。

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

api/publishaudit/history、api/publishaudit/entityhistory、api/publishaudit/schemahistoryにクエリを記述する場合は、次のオプションパラメータを含めることができます。

パラメーター	種類	形容
startDate	datetime	検索の日時範囲の開始 (UTC)。これが指定されていない場合、クエリは使用可能なすべての監査エントリを返します。
endDate	datetime	検索の日時範囲の終了 (UTC)。これが指定されていない場合、クエリは使用可能なすべての監査エントリを返します。
searchAfter	string	前のクエリから返されたsearchAfterプロパティ値に基づく、次の検索を開始するポイント。複数の値がある場合は、カンマで区切ります。
take	integer	1つの要求で返す項目の数。デフォルト値: 10.
fullText	string	全文検索で使用する用語。このパラメータに値を指定すると、リクエストは、その値を含むフィールドを持つ監査エントリのみを返します。

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

次のサンプルクエリでは、history/<tenant name> エンドポイントを使用して、すべての発行操作の一般的な監査ログをフェッチします。

クエリ：

GET https://<HOSTNAME>/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://<HOSTNAME>/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:22.8337201Z",
   "@timestamp": "2023-08-17T17:27:22.8337201Z",
   "user_id": 805
  },
  {
   "delivery_messsage_id": "a9e5997f-e484-4eaa-a9a7-748e9f2ba712",
   "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": "d7dbfe7d-8375-47fd-8ede-1a7e2796f205",
   "event_type": null,
   "severity": null,
   "target_id": 9787,
   "target_identifier": "M.ContentType.SocialMediaMessage",
   "timestamp": "2023-08-17T17:27:22.8263286Z",
   "@timestamp": "2023-08-17T17:27:22.8263286Z",
   "user_id": 805
  },
  {
   "delivery_messsage_id": "20628934-e62b-4471-88c5-468d930e4bd6",
   "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": "129c39ab-6e3a-4eb2-bb8e-84a2e43e4b32",
   "event_type": null,
   "severity": null,
   "target_id": 9791,
   "target_identifier": "M.ContentType.Email",
   "timestamp": "2023-08-17T17:27:22.8186412Z",
   "@timestamp": "2023-08-17T17:27:22.8186412Z",
   "user_id": 805
  }
 ],
 "total_items": 873,
 "searchAfter": "1692293242818,129c39ab-6e3a-4eb2-bb8e-84a2e43e4b32"
}

この記事を改善するための提案がある場合は、お知らせください!