Acquire Trace Log details

This is an API function to acquire Trace Log details. This API function corresponds to the operation on the screen that is displayed by clicking the [Trace Log] tab after selecting the [Logs] on the operation screen of Manager.

= Remarks =

It is the difference between the acquire a list of Trace Logs API function and this API function that the following parameters are not included in the response of this API function.

  • content layer (Parameters under the content layer of the acquire a list API function are the same as the parameters of the acquire details API function.)

  • first

  • last

  • number

  • numberOfElements

  • size

  • sort

  • totalElements

  • totalPages
Format
curl -X GET --header 'Accept: application/json'
            --header 'X-API-KEY:APIKEY'
            'http://HOSTNAME:PORTNUMBER/api/v1/trace-logs/traceLogUniqueId'
Request parameter (Path format)
Item name Request parameter Type Value Default value
Trace Log Unique ID traceLogUniqueId String   Impossible to omit
Response
{
  "agentId": "string",
  "agentName": "string",
  "eventDateTimeStr": "string",
  "eventDateTimeUtc": 0,
  "eventMessage": "string",
  "hostName": "string",
  "logLevel": "string",
  "osExitCode": "string",
  "osUserName": "string",
  "pid": "string",
  "profileId": "string",
  "profileName": "string",
  "traceLogId": "string",
  "traceLogUniqueId": "string",
  "unitId": "string",
  "unitName": "string"
}
Response parameter
Item name Response parameter Type Value
Agent ID agentId String

The ID of Agent that output the log is returned.
Agent Name agentName String The name of Agent that output the log is returned.
Date and Time of Occurrence (string) eventDateTimeStr String

"day-of-week month day hour:minute:second year"

Example: "Tue Jan 24 15:09:26 2017"
Date and Time of Occurrence (UTC) eventDateTimeUtc Integer

The number of seconds that has accumulated since midnight of 1970/1/1 (UTC)
Message eventMessage String The message that was related to the occurred event is returned.
Host Name hostName String

The host name of Agent that output the log is returned.
Log Level logLevel String "INFOMATION"　|　"WARNING"　|　"ERROR"
OS End Code osExitCode String OS End Code that was related to the occurred event is returned.
OS User Name osUserName String OS User Name who started Agent is returned.
PID pid String

The process ID of Agent that output the log is returned.
Profile ID profileId String

The ID of Profile that was allocated to Agent that output the log is returned.
Profile Name profileName String The name of Profile that was allocated to Agent that output the log is returned.
Trace Log ID traceLogId String The ID of the Trace Log that was allocated to a message is returned.

Trace Log Unique ID

 traceLogUniqueId String The ID to be used for identifying the Trace Log is returned.
Unit ID unitId String

The ID of Unit that was allocated to Agent that output the log is returned.
Unit Name unitName String The name of Unit that was allocated to Agent that output the log is returned.