APIキー利用状況 : 一覧と検索¶

このページでは、APIキー利用状況の一覧と検索方法について記載します。

確認方法¶

メニューバーの [アカウント] - [APIキー利用状況] をクリックすると、利用履歴の画面が表示されます。(初期表示ではデータが表示されません。)

APIキー利用状況とは

APIキー利用状況を、成功と、失敗で集計した結果を表示します。
APIの成功、失敗は、APIの呼び出しが正常か否かを示します。不正アクセスやパラメータ異常など、致命的なエラーを失敗として集計します。
※認証系のAPIでは、APIの呼び出しが正しく、認証に問題がある場合は、成功としてカウントします。例えば、OATH認証で古いOTPを認証した場合、APIの呼び出しは成功としてカウントアップされますが、メッセージの詳細はBAT_OTPとなります。詳細な絞り込みは、メッセージのフィルター機能で絞り込むことが可能です。

画面構成¶

集計したい日付範囲を指定し、集計ボタンをクリックすると APIキー利用状況を集計し、概要欄に集計結果を表示します。更に概要欄の集計結果が、1件以上の表示枠をクリックすると、検索欄に一覧を表示します。検索欄の行をクリックすると、詳細欄に詳細データを表示します。

APIキー利用状況では、DAuth APIを使用して実行された、デバイス利用状況（成功/失敗）をAPIキー別に把握することができます。

また、集計結果の件数表示部分をクリックすると、詳細履歴を表示することが可能です。

保存期間

利用履歴の保管期間は30日です。現在日時から30日の範囲で集計期間を指定することが可能です。

検索画面の使い方

検索画面の使い方は、サービス共通です。
こちらを参照してください。

概要欄¶

項目	内容
期間	集計を行う日付範囲。
集計	集計を実行します。
対象API	集計対象のAPI種別を指定します。認証系：認証に関連する、YUBIKEY_VERIFY,FIDO_ASSERTION,OATH_VERIFY,NJS_ATKEY_VERIFY,DKVS_GET_VALUEを抽出します。認証系以外：認証以外の利用状況を抽出
APIキー名	API Keyの名前です。
ネームスペース	同じネームスペースのリソースを使用できます。
YubiKey 成功	YubiKeyの利用状況の成功件数。
YubiKey 失敗	YubiKeyの利用状況の失敗件数。
FIDO 成功	FIDOの利用状況の成功件数。
FIDO 失敗	FIDOの利用状況の失敗件数。
OATH 成功	OATHの利用状況の成功件数。
OATH 失敗	OATHの利用状況の失敗件数。
NJS ATKey 成功	NJS ATKeyの利用状況の成功件数。
NJS ATKey 失敗	NJS ATKeyの利用状況の失敗件数。
DKVS 成功	DKVSの利用状況の成功件数。
DKVS 失敗	DKVSの利用状況の失敗件数。

検索欄¶

項目	内容
実行日時	APIを実行した日時です。
実行コード	APIを実行したコード種別です。実行コードはこちらを参照してください。
処理結果	APIの実行結果です。処理結果の内容はこちらを参照してください。
メッセージ	APIの実行結果のメッセージです。
メッセージ	APIの実行ログです。

詳細欄¶

説明タブ¶

項目	内容
実行日時	APIを実行した日時です。
ユーザコード	APIを実行したユーザコードです。
APIキー	APIキーです。
URI	APIを実行したURIです。
実行コード	APIを実行したコード種別です。実行コードはこちらを参照してください。
処理結果	APIの実行結果です。処理結果の内容はこちらを参照してください。
処理時間	APIの処理時間です。
メッセージ	APIの実行結果のメッセージです。

ログタブ¶

項目	内容
メッセージ	APIの実行ログです。