Web APIの利用状況を確認する¶
1日および5分間隔におけるWeb APIのリクエスト数、通信量、上限超過の状況を確認できます。
なお、Web APIの利用状況を確認するにはシステム管理者の権限が必要です。
1日のWeb API利用状況を確認する¶
- 確認したい日付を指定します。初期表示時は当日データです。
- [1] 上限
- 1日に実行できるAPIリクエスト数、API通信量（単位：MB）を表示します。
- [2] 使用中
- 実行されたAPIリクエスト数、API通信量（単位：MB）を表示します。
- [3] 1日上限超過
- 1日の上限を超過して呼び出されたAPIリクエスト数を表示します。
ちなみに
5分間隔のWeb API利用状況を確認する¶
- 確認したい日付を指定します。初期表示時は当日データです。
- [1] APIリクエスト数
- 実行されたAPIリクエスト数を表示します。
- [2] API通信量
- 実行されたAPIの通信量（単位：KB）を表示します。
- [3] 短期間上限超過リクエスト数
- 短期間（5分）の上限を超過して実行されたリクエスト数を表示します。
- [4] 一日上限超過リクエスト数
- 1日の上限を超過して実行されたリクエスト数を表示します。
ちなみに
Web API アクセスログをダウンロードする¶
1.「APIアクセスログ」の「ダウンロード」ボタンをクリックし、「APIアクセスログダウンロード」ビューを開きます。
- APIのアクセスアクセスログをダウンロードした期間を指定し、「ダウンロード」ボタンをクリックします。
ちなみに
ヒント
フィールド 内容 api_op_date API実行日時 company_id 企業ID api_name API名 api_type API種別 request_size リクエストサイズ（単位：バイト） response_size レスポンスサイズ（単位：バイト） response_code HTTPレスポンスステータスコード time_taken 処理時間（単位：ミリ秒） ip_address アクセス元IPアドレス
値 APIの種類 QueryRecords テーブルの検索条件を指定し、検索結果一覧を取得する GetRecord テーブルのデータを1件取得する InsertRecord テーブルのデータを1件登録する UpdateRecord テーブルのデータを1件更新する DeleteRecord テーブルのデータを1件削除する BulkInsertRecords テーブルのデータを一括登録する BulkUpdateRecords テーブルのデータを一括更新する BulkUpsertRecords テーブルのデータを一括登録・更新する BulkDeleteRecords テーブルのデータを一括削除する GetHeader テーブルの最終更新日時を取得する（ヘッダ情報のみ） GetRecords テーブルのデータを一括取得する KnowledgeReference ナレッジの検索条件を指定し、ナレッジ情報を参照する
WebAPI エクステンションプラスの利用状況を確認する¶
WebAPI エクステンションプラスには WebAPI の制限と別に実行回数の上限があります。
利用状況については「利用状況」ビューより確認することができます。
「利用状況」ビューについては 利用状況を確認する を参照ください。
契約プランが年額の場合
契約プランが月額の場合
- [1] 利用状況
WebAPI エクステンションプラスの利用状況を確認できます。
項目名 内容 利用回数（月間、年間） 上限列は利用できる上限数を示しています。ご契約内容に応じて上限数は異なります。 現在は利用した回数が表示されます。 - [2] 月別利用状況
- 月別の WebAPI エクステンションプラス実行回数を確認することができます。