システム設定(ログ)取得

システム設定のログ設定情報を取得するためのAPIです。Manager画面右上のユーザー名のボタンから[システム設定]を選択した後、[ログ]タブを選択したときに表示される画面での操作に相当します。

= 備考 =

次のAPIのレスポンスパラメータは同じです。

  • システム設定(ログ)取得API
  • システム設定(ログ)変更API
書式

curl -X GET --header 'Accept: application/json'

--header 'X-API-KEY:APIキー'

'http://ホスト名:ポート番号/api/v1/system-settings'

リクエストパラメータ
リクエストパラメータは不要です。
レスポンス

{

  "deviceAccessLogSettings": {

    "cron": "string",

    "enableTruncate": true,

    "minusDays": 0,

    "offset": 0,

    "truncateMode": "string"

  },

  "receivingLogSettings": {

    "cron": "string",

    "enableTruncate": true,

    "minusDays": 0,

    "offset": 0,

    "truncateMode": "string"

  },

  "traceLogSettings": {

    "cron": "string",

    "enableTruncate": true,

    "minusDays": 0,

    "offset": 0,

    "truncateMode": "string"

  },

  "transferLogSettings": {

    "cron": "string",

    "enableTruncate": true,

    "hulrcvLogHistoryMode": 0,

    "minusDays": 0,

    "offset": 0,

    "truncateMode": "string"

  }

}

レスポンスパラメータ
項目名 レスポンスパラメータ

アクセスログのトランケートスケジュール

deviceAccessLogSettings

cron 文字列

"秒 分 時 日 月 曜日"(例:0 0 10-18 * * MON-FRI)

先頭に秒が追加されていること以外は、標準的なcronのフォーマットと同一です。

アクセスログのトランケート(On/Off)

enableTruncate 論理型

• true:On

• false:Off

アクセスログの閾値

(日付)

minusDays 数値

1~2147483647

ログを保存する日数の上限が返却されます。

アクセスログの閾値

(行数)

offset 数値

1~2147483647

ログを保存する行数の上限が返却されます。

アクセスログのトランケートモード truncateMode 文字列

"OFFSET" | "DATETIME"

• OFFSET:行数を基にトランケート

• DATETIME:日付を基にトランケート

受信履歴のトランケートスケジュール

receivingLogSettings cron 文字列

"秒 分 時 日 月 曜日"(例:0 0 10-18 * * MON-FRI)

先頭に秒が追加されていること以外は、標準的なcronのフォーマットと同一です。

受信履歴のトランケート(On/Off)

enableTruncate 論理型

• true:On

• false:Off

受信履歴の閾値

(日付)

minusDays 数値

1~2147483647

ログを保存する日数の上限が返却されます。

受信履歴の閾値

(行数)

offset 数値

1~2147483647

ログを保存する行数の上限が返却されます。

受信履歴のトランケートモード truncateMode 文字列

"OFFSET" | "DATETIME"

• OFFSET:行数を基にトランケート

• DATETIME:日付を基にトランケート

トレースログのトランケートスケジュール

traceLogSettings cron 文字列

"秒 分 時 日 月 曜日"(例:0 0 10-18 * * MON-FRI)

先頭に秒が追加されていること以外は、標準的なcronのフォーマットと同一です。

トレースログのトランケート(On/Off)

enableTruncate 論理型

• true:On

• false:Off

トレースログの閾値

(日付)

minusDays 数値

1~2147483647

ログを保存する日数の上限が返却されます。

トレースログの閾値

(行数)

offset 数値

1~2147483647

ログを保存する行数の上限が返却されます。

トレースログのトランケートモード truncateMode 文字列

"OFFSET" | "DATETIME"

• OFFSET:行数を基にトランケート

• DATETIME:日付を基にトランケート

転送履歴のトランケートスケジュール

transferLogSettings cron 文字列

"秒 分 時 日 月 曜日"(例:0 0 10-18 * * MON-FRI)

先頭に秒が追加されていること以外は、標準的なcronのフォーマットと同一です。

転送履歴のトランケート(On/Off)

enableTruncate 論理型

• true:On

• false:Off

履歴出力モード

(集信履歴設定)

hulrcvLogHistoryMode 数値

0 | 1

• 0:異常時のみ履歴出力する

• 1:常時履歴出力する

転送履歴の閾値

(日付)

minusDays 数値

1~2147483647

ログを保存する日数の上限が返却されます。

転送履歴の閾値

(行数)

offset 数値

1~2147483647

ログを保存する行数の上限が返却されます。

転送履歴のトランケートモード truncateMode 文字列

"OFFSET" | "DATETIME"

• OFFSET:行数を基にトランケート

• DATETIME:日付を基にトランケート