Acquire system settings (logs)

This is an API function to acquire information of log settings from 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 GET --header 'Accept: application/json'
            --header 'X-API-KEY:APIKEY'
            'http://HOSTNAME:PORTNUMBER/api/v1/system-settings'
Request parameter
A request parameter is not required.
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
Item name Response parameter Type Value

Truncation schedule for the Access Log

deviceAccessLogSettings

 cron String

"second minute hour day month day-of-week" (Example: 0 0 10-18 * * MON-FRI)

Other than the addition of seconds at the beginning, this format is the same as the standard cron format.

Truncating the Access Log

(On/Off)

 enableTruncate Boolean

•　true: On

•　false: Off

Threshold for the Access Log (Days)

 minusDays Integer

1 to 2147483647

The maximum number of days to keep the logs is returned.

Threshold for the Access Log (Records)

 offset Integer

1 to 2147483647

The maximum number of records to keep the logs is returned.
Truncation Mode for the Access Log truncateMode String

"OFFSET"　|　"DATETIME"

•　OFFSET: truncate based on a number of records

•　DATETIME: truncate based on date

Truncation schedule for the Receive Log

 receivingLogSettings cron String

"second minute hour day month day-of-week" (Example: 0 0 10-18 * * MON-FRI)

Other than the addition of seconds at the beginning, this format is the same as the standard cron format.

Truncating the Receive Log

(On/Off)

 enableTruncate Boolean

•　true: On

•　false: Off

Threshold for the Receive Log (Days)

 minusDays Integer

1 to 2147483647

The maximum number of days to keep the logs is returned.

Threshold for the Receive Log (Records)

 offset Integer

1 to 2147483647

The maximum number of records to keep the logs is returned.
Truncation Mode for the Receive Log truncateMode String

"OFFSET"　|　"DATETIME"

•　OFFSET: truncate based on a number of records

•　DATETIME: truncate based on date

Truncation schedule for the Trace Log

 traceLogSettings cron String

"second minute hour day month day-of-week" (Example: 0 0 10-18 * * MON-FRI)

Other than the addition of seconds at the beginning, this format is the same as the standard cron format.

Truncating the Trace Log

(On/Off)

 enableTruncate Boolean

•　true: On

•　false: Off

Threshold for the Trace Log (Days)

 minusDays Integer

1 to 2147483647

The maximum number of days to keep the logs is returned.

Threshold for the Trace Log (Records)

 offset Integer

1 to 2147483647

The maximum number of records to keep the logs is returned.
Truncation Mode for the Trace Log truncateMode String

"OFFSET"　|　"DATETIME"

•　OFFSET: truncate based on a number of records

•　DATETIME: truncate based on date

Truncation schedule for the Transfer Log

 transferLogSettings cron String

"second minute hour day month day-of-week" (Example: 0 0 10-18 * * MON-FRI)

Other than the addition of seconds at the beginning, this format is the same as the standard cron format.

Truncating the Transfer Log

(On/Off)

 enableTruncate Boolean

•　true: On

•　false: Off

Log Output Mode (Receive Log Settings on the receiver)

 hulrcvLogHistoryMode Integer

0 | 1

•　0: Only when an error occurs

•　1: Always

Threshold for the Transfer Log (Days)

 minusDays Integer

1 to 2147483647

The maximum number of days to keep the logs is returned.

Threshold for the Transfer Log (Records)

 offset Integer

1 to 2147483647

The maximum number of records to keep the logs is returned.
Truncation Mode for the Transfer Log truncateMode String

"OFFSET"　|　"DATETIME"

•　OFFSET: truncate based on a number of records

•　DATETIME: truncate based on date