システム設定(ログ)変更

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

= 備考 =

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

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

curl -X PUT --header 'Content-Type: application/json'

--header 'Accept: application/json'

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

-d 'JSON形式のリクエストボディ'

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

リクエストボディ(JSON形式)

{

  "deviceAccessLogSettings": {

    "enableTruncate": true,

    "minusDays": 0,

    "offset": 0,

    "truncateMode": "string"

  },

  "receivingLogSettings": {

    "enableTruncate": true,

    "minusDays": 0,

    "offset": 0,

    "truncateMode": "string"

  },

  "traceLogSettings": {

    "enableTruncate": true,

    "minusDays": 0,

    "offset": 0,

    "truncateMode": "string"

  },

  "transferLogSettings": {

    "enableTruncate": true,

    "hulrcvLogHistoryMode": 0,

    "minusDays": 0,

    "offset": 0,

    "truncateMode": "string"

  }

}

リクエストパラメータ(JSON形式)
項目名 リクエストパラメータ 省略値
アクセスログのトランケート(On/Off) deviceAccessLogSettings enableTruncate 論理型

• true:On

• false:Off

 

アクセスログの閾値

(日付)

minusDays 数値

1~2147483647

ログを保存する日数の上限を指定します。

例えば「30」と指定した場合、30日分のログを保存します。

 

アクセスログの閾値

(行数)

offset 数値

1~2147483647

ログを保存する行数の上限を指定します。

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

"OFFSET" | "DATETIME"

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

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

 

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

receivingLogSettings enableTruncate 論理型

• true:On

• false:Off

 

受信履歴の閾値

(日付)

minusDays 数値

1~2147483647

ログを保存する日数の上限を指定します。

例えば「30」と指定した場合、30日分のログを保存します。

 

受信履歴の閾値

(行数)

offset 数値

1~2147483647

ログを保存する行数の上限を指定します。

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

"OFFSET" | "DATETIME"

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

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

 
トレースログのトランケート(On/Off) traceLogSettings enableTruncate 論理型

• true:On

• false:Off

 

トレースログの閾値

(日付)

minusDays 数値

1~2147483647

ログを保存する日数の上限を指定します。

例えば「30」と指定した場合、30日分のログを保存します。

 

トレースログの閾値

(行数)

offset 数値

1~2147483647

ログを保存する行数の上限を指定します。

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

"OFFSET" | "DATETIME"

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

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

 

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

transferLogSettings enableTruncate 論理型

• true:On

• false:Off

 

履歴出力モード

(集信履歴設定)

hulrcvLogHistoryMode 数値

集信履歴を常時出力するか、エラーが発生したときにだけ出力するかを選択します。

0 | 1

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

• 1:常時履歴出力する

 

転送履歴の閾値

(日付)

minusDays 数値

1~2147483647

ログを保存する日数の上限を指定します。

例えば「30」と指定した場合、30日分のログを保存します。

 

転送履歴の閾値

(行数)

offset 数値

1~2147483647

ログを保存する行数の上限を指定します。

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

"OFFSET" | "DATETIME"

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

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

 
レスポンス

{

  "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"

  }

}

レスポンスパラメータ

レスポンスパラメータについては、「システム設定(ログ)取得」「レスポンスパラメータ」を参照してください。