Modify system settings (logs)

This is an API function to modify the log settings of the system settings. This API function corresponds to the operation on the screen that is displayed by clicking the [Log] tab after selecting the [System Settings] from the [user-name] button that is displayed on the right-top of the operation screen of Manager.

= Remarks =

The response parameters of the following API functions are the same. (/api/v1/system-settings)

  • Acquire system settings (logs)
  • Modify system settings (logs)
Format
curl -X PUT --header 'Content-Type: application/json'
            --header 'Accept: application/json'
            --header 'X-API-KEY:APIKEY'
            -d 'REQUESTBODYINJSONFORMAT'
            'http://HOSTNAME:PORTNUMBER/api/v1/system-settings'
Request body (JSON format)
{
　　"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"
　　}
}
Request Parameter (JSON format)
Item name Request parameter Type Value Default value

Truncating the Access Log (On/Off)

 deviceAccessLogSettings enableTruncate Boolean

•　true: On

•　false: Off

  

Threshold for the Access Log (Days)

 minusDays Integer

1 to 2147483647

Specify the maximum number of days to keep logs.

For example, if 30 is specified, logs are kept for 30 days.

  

Threshold for the Access Log (Records)

 offset Integer

1 to 2147483647

Specify the maximum number of records to keep logs.

  
Truncation Mode for the Access Log truncateMode String

"OFFSET"　|　"DATETIME"

•　OFFSET: truncate based on a number of records

•　DATETIME: truncate based on date

  

Truncating the Receive Log (On/Off)

 receivingLogSettings enableTruncate Boolean

•　true: On

•　false: Off

  

Threshold for the Receive Log (Days)

 minusDays Integer

1 to 2147483647

Specify the maximum number of days to keep logs.

For example, if 30 is specified, logs are kept for 30 days.

  

Threshold for the Receive Log (Records)

 offset Integer

1 to 2147483647

Specify the maximum number of records to keep logs.

  
Truncation Mode for the Receive Log truncateMode String

"OFFSET"　|　"DATETIME"

•　OFFSET: truncate based on a number of records

•　DATETIME: truncate based on date

  

Truncating the Trace Log (On/Off)

 traceLogSettings enableTruncate Boolean

•　true: On

•　false: Off

  

Threshold for the Trace Log (Days)

 minusDays Integer

1 to 2147483647

Specify the maximum number of days to keep logs.

For example, if 30 is specified, logs are kept for 30 days.

  

Threshold for the Trace Log (Records)

 offset Integer

1 to 2147483647

Specify the maximum number of records to keep logs.

  
Truncation Mode for the Trace Log truncateMode String

"OFFSET"　|　"DATETIME"

•　OFFSET: truncate based on a number of records

•　DATETIME: truncate based on date

  

Truncating the Transfer Log (On/Off)

 transferLogSettings enableTruncate Boolean

•　true: On

•　false: Off

  
Log Output Mode (Receive Log Settings on the receiver) hulrcvLogHistoryMode Integer

Specify whether HULFT always outputs Receive Logs or whether HULFT outputs Receive Logs only when an error occurs.

0 | 1

•　0: output receive logs only when an error occurs

•　1: output receive logs always

  

Threshold for the Transfer Log (Days)

 minusDays Integer

1 to 2147483647

Specify the maximum number of days to keep logs.

For example, if 30 is specified, logs are kept for 30 days.

  

Threshold for the Transfer Log (Records)

 offset Integer

1 to 2147483647

Specify the maximum number of records to keep logs.

  
Truncation Mode for the Transfer Log truncateMode String

"OFFSET"　|　"DATETIME"

•　OFFSET: truncate based on a number of records

•　DATETIME: truncate based on date

  
Response
{
　　"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"
　　}
}
Response parameter

For details of the response parameters, see Response parameter described in Acquire system settings (logs).