ログ取得公開APIについて – Legacy with DX Portal

APIの実行ログはダッシュボートから確認が可能となっておりますが、取得用APIが公開されておりますので、APIの実行によるログ取得が可能となっております。

ダッシュボートからログの確認方法は下記のリンクご参照ください。

ダッシュボード – Legacy with DX Portal (omni-s.co.jp)

APIの仕様は以下となります。

リクエスト仕様

リクエストURI	http://(サーバーIP):9527/dev-api/apps/logapi
HTTPメソッド	GET

リクエストヘッダ仕様

Content-Type

application/json

Authorization

認証トークン情報を指定します。

「Bearer トークン文字列」の形式で指定します。

トークンはシステム設定の「公開API」でトークンを設定している場合のみ必要となります。設定の詳細は「トークン認証設定」の項をご参照ください。

リクエストボディ仕様

キー	型	必須	説明
fields	配列	任意	取得する項目を配列で指定します。指定可能な項目は別途「ログ項目」の項をご参照ください。（例）["apiUrl","method","statusCode"] 省略時は全ての「ログ項目」を取得します。
size	数値	任意	1度のAPIで取得できるレコードの数です。1～500が指定可能です。省略時は場合は100レコードになります。
condition	オブジェクト	任意	検索条件を指定します。下記の形式で複数指定が可能となります。省略時は検索条件無しで取得します。検索項目(※1):{ cond: '検索条件(※2)', val:検索値 } ※1 「ログ項目」のいずれかが指定可能です。 ※2 '=','<>','>','>=','<','<='のいずれかが指定可能です。
order	オブジェクト	任意	取得時のソートを指定します。省略時はソート指定無しで取得します。ソート項目(※1):並び順(※2) ※1 「ログ項目」のいずれかが指定可能です。 ※2 'asc','desc'のいずれかが指定可能です。
format	文字列	任意	取得形式を指定します。 'json'か'csv’のいずれかを指定します。省略時はjson形式の取得になります。

ログ項目

apiname	API名称
apiUrl	実行APIのURL
method	実行メソッド
clientIp	APIを実行したクライアントIPアドレス
request	API実行時のリクエスト情報
statusCode	API実行結果のステータスコード
errorMessage	API実行時のエラーメッセージ
createdAt	ログの作成日時

リクエストボディの例

{
    "fields":["apiname","apiUrl","statusCode"],
    "size":300,
    "condition":{
        "statusCode":{
            "cond":"=",
            "val":"500"
        },
        "createdAt":{
            "cond":">=",
            "val":20200501
        }
    },
    "order":{
        "createdAt":"desc"
    },
    "format":"json"
}

トークン認証設定

「管理」＞「設定」＞「公開API」から設定できます。

●　「ログ取得APIを公開する」がONになってる場合のみ、API実行が可能です。

●　同画面で「API認証トークン」の設定ボタンがあり、API実行時にトークン必須する場合は設定が可能となっております。

トークン認証設定

関連記事