Acquire a list of Trace Logs

This is an API function to acquire a list of Trace Logs. 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 =

The response parameters under the content layer of this API function are the same as the response parameters of the acquire Trace Log details API function.
Format
curl -X GET --header 'Accept: application/json'
            --header 'X-API-KEY:APIKEY'
            'http://HOSTNAME:PORTNUMBER/api/v1/trace-logs?REQUESTINQUERYFORMAT'
Request parameter (Query format)
Item name Request parameter Type Value Default value
Agent ID agentId String

Specify the ID of Agent that output the log.

Exact match

  
Agent Name agentName String

Specify the name of Agent that output the log.

Exact match

  

Date and Time of Occurrence (start)

 geEventDate Integer

The number of seconds that has accumulated since midnight of 1970/1/1 (UTC)

You can specify one parameter only. If you specify both parameters, you can set a period of a search target.

  

Date and Time of Occurrence (end)

 leEventDate Integer  
Log Level logLevel String

"INFOMATION" | "WARNING" | "ERROR"

  
PID pid String

Specify the process ID of Agent that output the log.

Exact match

  
Sort Order sort String

"+parameter-name" | "-paramater-name"

•　+: Ascending order

•　-: Descending order

If you specify multiple parameters, divide values by a comma (,).

 -eventDateTimeUtc
Number of pages page Integer

Specify a number from zero.

If the number of pages is 1, specify 0.

 0
Number of items per page size Integer   10
Parameters that can be set to Sort Order
Item name Parameter name
Agent ID agentId
Agent Name agentName
Date and Time of Occurrence (string) eventDateTimeStr
Date and Time of Occurrence (UTC) eventDateTimeUtc
Message eventMessage
Host Name hostName
Log Level logLevel
OS End Code osExitCode
OS User Name osUserName
PID pid
Profile ID profileId
Profile Name profileName
Trace Log ID traceLogId

Trace Log Unique ID

 traceLogUniqueId
Unit ID unitId
Unit Name unitName
Response
{
  "content": [
    {
      "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"
    }
  ],
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "size": 0,
  "sort": [],
  "totalElements": 0,
  "totalPages": 0
}
Response parameter

For details of the parameters under the content layer, see Response parameter described in Acquire Trace Log details.

Also, for details about the parameters for page settings (first, last, number, numberOfElements, size, sort, totalElements, totalPages), see Response parameters for page settings.