REST および SOAP API アナリティクスの収集とクリーンアップ

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間:3分
  • API アナリティクスでは、スケジュール済みジョブを使用してアナリティクスデータを収集してクリーンアップします。

    インスタンスは、包含リストにある API のすべての Web サービストランザクションを追跡し、リソースと HTTP アクションの組み合わせ別に集計された日次履歴を維持します。要求者情報は、要求者、リソース、および HTTP アクションの組み合わせごとに集計され、プロパティ com.glide.api.stats.daily_ limitで定義された日次制限まで追跡されます。

    ログに記録される要求を確認するには、次のテーブルを参照してください。
    表 : 1. ログに記録された要求
    API 名 サンプルリソース 応答コード 説明 ログに記録されました
    now/table /api/now/table/incident 401 を除くいずれか 有効なリソースとテーブル はい
    now/table /api/now/table/invalidResource 400 リソースは有効ですが、テーブルが無効です はい
    now/table /api/now/table/incident 403 要求ユーザーには十分な権限がありません はい
    now/table /api/now/table/incident 401 要求ユーザーの認証が行われていません いいえ
    myApp/myScriptedApi myApp/myScriptedApi/myResource 401 を除くいずれか 有効なリソース はい
    myApp/invalidApiName
    • myApp/invalidApiName
    • myApp/invalidApiName/myResource
    400 一致する包含リストエントリーがあっても、API が無効です いいえ

    毎月 2 日に、API 月次統計のスケジュール済みジョブによって、各リソースと HTTP アクションの組み合わせの月次合計が計算されます。[API 月次要求者統計情報 (API Monthly Requestor Stats)] スケジュール済みジョブは、2 日以上経過した日次スコアに基づいて、各リソース、要求者、および HTTP アクションの組み合わせの月次合計を毎日計算します。

    日次統計は 33 日間維持されます。月次合計は 13 か月間維持されます。sys_api_stats、sys_api_stats_requestor、およびsys_api_stats_requestor_monthlyテーブルのテーブルクリーナーは、これらの制限よりも古いアナリティクスレコードを削除します。

    REST & SOAP API アナリティクスの命名

    API アナリティクスを追跡するときに使用される API 名 は、REST API やスクリプト化された SOAP サービスなど、記述されている API のタイプによって決まります。

    API タイプ 説明
    REST API 名空間と、名前空間に続く URI の最初の部分が API 名として使用されます。

    たとえば、テーブル API エンドポイント api/now/table/incident および api/now/table/problem の場合、名前空間と ID は now/table です。

    直接 SOAP (テーブルはインポートセット行テーブルを拡張しません) 直接 SOAP 要求がテーブルにアクセスする場合、直接 SOAP が API 名として使用されます。
    SOAP インポート (テーブルはインポートセット行テーブルを拡張します) インポートセット SOAP は API 名として使用されます。
    スクリプト化された SOAP サービス SOAP 要求エンドポイントページは、my_service.do などの API 名として使用されます。