呼び出し記録
機能概要
機能の位置付け
呼び出し記録 は、API サービスで発生した呼び出しログを集中確認する画面です。サービスカテゴリや検索条件で単一呼び出しを特定し、呼び出し元、インターフェースアドレス、データ量、所要時間、状態、異常情報を確認し、必要に応じて対象レコードを削除できます。
簡単に言うと：API が呼び出されるたびに、「誰がどのインターフェースを呼び出し、何を渡し、どれくらい時間がかかり、結果がどうだったか」をここで確認できます。
利用のヒント
単一 API 呼び出しを調査する場合は、サービスカテゴリまたはサービス名で範囲を絞る → 一覧のインターフェースアドレスと所要時間を確認 → 【詳細】でパラメータ、状態、異常情報を確認 の順で操作することを推奨します。
主な特徴
- 組み合わせ検索：API サービスカテゴリ、API サービス名称、状態、呼び出し時間で記録を検索できます。
- 呼び出し概要：API サービス名称、カテゴリ、呼び出し元 IP、インターフェースアドレス、呼び出しデータ量、所要時間を確認できます。
- 詳細確認：【詳細】で単一呼び出しのパラメータ、時間、方式、状態、異常情報を確認できます。
- 単一削除：対象呼び出し記録を削除できます。この操作は他の業務に影響しません。
- ページング情報：総件数、ページサイズ、現在ページ、ページングコントロールを確認できます。
適用範囲
【呼び出し記録】は、API サービスで発生した呼び出し記録を確認・特定するために使用します。API 管理とサービス分類は、サービス名称、インターフェースアドレス、カテゴリなどの上流情報を提供します。本ページでは、記録検索、詳細確認、単一削除入口を説明し、ダウンロード、エクスポート、実際のページ遷移結果、削除確認文言、権限ルールは説明しません。
事前準備
前提条件
- qData プラットフォームにログインしていること。
- 現在のアカウントで【データサービス】モジュールにアクセスできること。
- 現在のアカウントで【呼び出し記録】メニューが表示されること。
- システム内に閲覧可能な API 呼び出し記録が存在すること。
ナビゲーションパス
データサービス > 呼び出し記録
画面概要
【呼び出し記録】に入ると、左側に API サービスカテゴリ検索とカテゴリ入口、上部に API サービス名称、状態、呼び出し時間、【検索】、【リセット】が表示されます。中央には呼び出し記録一覧と【詳細】【削除】入口、下部にはページング情報とページングコントロールが表示されます。
呼び出し記録一覧項目
| 項目名 | 説明 | 必須 |
|---|---|---|
| 番号 | 現在の呼び出し記録番号です。 | 該当なし |
| API サービス名称 | 今回の呼び出しに関連する API サービス名称です。 | 該当なし |
| API サービスカテゴリ | 今回の呼び出しに関連する API の所属カテゴリです。 | 該当なし |
| 呼び出し元 IP | 呼び出しを開始したクライアントのネットワークアドレスです。 | 該当なし |
| 呼び出しインターフェースアドレス | 今回の呼び出しで実際に使用したインターフェースパスです。 | 該当なし |
| 呼び出しデータ量 | システムが記録した今回の呼び出しデータ量です。 | 該当なし |
| 呼び出し所要時間（秒） | 今回の呼び出しにかかった時間です。単位は秒です。 | 該当なし |
| 操作 | 【詳細】と【削除】入口を表示します。 | 該当なし |
推奨操作フロー
呼び出し状況確認：【呼び出し記録】へ入る → サービスカテゴリまたは検索条件を選択 → 【検索】をクリック → インターフェースアドレス、データ量、所要時間を確認。
単一呼び出し調査：一覧で対象記録を探す → 【詳細】をクリック → 呼び出しパラメータ、リクエスト方式、状態、異常情報を確認 → 詳細ダイアログを閉じる。
対象記録整理：対象記録を確認して【削除】をクリック → 同じ条件で再検索 → 対象記録が返されず、他の記録が正常に存在することを確認。
操作説明
呼び出し記録ページへ入る
- 【データサービス】モジュールに入ります。
- 左側の【呼び出し記録】メニューをクリックします。
- 上部で【呼び出し記録】タブが有効であることを確認します。
- 呼び出し記録ページ本体を確認します。
呼び出し記録を検索する
- 左側カテゴリ検索欄に API サービスカテゴリキーワードを入力します。
- 左側で API サービスカテゴリを選択します。
- 「API サービス名称」にサービス名を入力します。
- 「状態」ドロップダウンで状態を選択します。
- 「呼び出し時間」で開始日を選択します。
- 「呼び出し時間」で終了日を選択します。
- 【検索】をクリックします。
- 呼び出し記録一覧で結果を確認します。
- 条件をクリアする場合は【リセット】をクリックします。
呼び出し記録一覧を確認する
- 呼び出し記録一覧を確認します。
- 対象サービス名称を探します。
- 対象記録の呼び出しインターフェースアドレスを確認します。
- 対象記録の呼び出しデータ量を確認します。
- 対象記録の呼び出し所要時間（秒）を確認します。
- 対象記録右側の【詳細】入口を確認します。
- 対象記録右側の【削除】入口を確認します。
- 一覧下部のページング情報とページングコントロールを確認します。
「状態」と「呼び出し時間」は検索条件であり、現在の一覧表示列ではありません。
API サービス呼び出しログ詳細を確認する
- 一覧で対象呼び出し記録を探します。
- 対象記録の操作列で【詳細】をクリックします。
- 「API サービス呼び出しログ詳細」ダイアログを確認します。
- API サービス名称、呼び出し元 IP、呼び出しインターフェースアドレスを確認します。
- 呼び出しパラメータ、呼び出し時間、所要時間、リクエスト方式を確認します。
- 呼び出しデータ量、異常情報記録、状態を確認します。
- 閉じる場合は右上の閉じるアイコン、または下部の【閉じる】をクリックします。
| 項目名 | 説明 | 必須 |
|---|---|---|
| API サービス名称 | 今回の呼び出しに関連する API サービス名称です。 | 該当なし |
| 呼び出し元 IP | 呼び出しを開始したクライアントのネットワークアドレスです。 | 該当なし |
| 呼び出しインターフェースアドレス | 今回の呼び出しで実際に使用したパスです。 | 該当なし |
| 呼び出しパラメータ | 今回の呼び出しで渡されたパラメータ内容を表示します。 | 該当なし |
| 呼び出し時間 | 今回の呼び出し発生時刻です。 | 該当なし |
| 呼び出し所要時間（秒） | 今回の呼び出しにかかった時間です。 | 該当なし |
| リクエスト方式 | 今回の呼び出しで使用した方式です。 | 該当なし |
| 呼び出しデータ量 | システムが記録した今回のデータ量です。 | 該当なし |
| 異常情報記録 | 今回の呼び出しの異常情報を表示します。 | 該当なし |
| 状態 | 今回の呼び出し処理状態を表示します。 | 該当なし |
対象呼び出し記録を削除する
- 一覧で削除する対象呼び出し記録を探します。
- 対象記録の操作列で【削除】をクリックします。
- 元の条件で呼び出し記録を再検索します。
- 削除済み対象記録が返されないことを確認します。
- 他の呼び出し記録、業務データ、業務フローに影響がないことを確認します。
よくある質問
- 呼び出し記録を 1 件削除すると他の業務に影響しますか？
影響しません。削除操作は対象呼び出し記録のみを削除し、他の呼び出し記録、業務データ、業務フローには影響しません。
まとめ
【呼び出し記録】は、API 呼び出し記録の検索、単一呼び出し詳細の確認、対象記録の削除に使用します。調査時は API サービス名称、インターフェースアドレス、呼び出しパラメータ、所要時間、状態、異常情報を重点的に確認してください。