REST & SOAP API 分析収集とクリーンアップ

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

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

    ログに記録される要求を確認するには、次のテーブルを参照してください。
    表 : 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 月次要求者統計情報のスケジュールジョブは毎日、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 サービス my_service.do など、SOAP 要求のエンドポイントページが API 名として使用されます。