Get existing logs

Edit online

Retrieves information about library service logs, snapshot logs, and drive service logs for this library. In the case of library service logs, this information includes whether it is still being created and how close it is, as a percentage, to being complete.

Request syntax

GET /v1/logs
Retrieves a list of existing log files.

GET /v1/logs/<filename>
Retrieves information about the log file with the specified file name.

Path parameters

filename (string)

The unique file name of the log file.

Example

> GET /v1/logs
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 45992
[
     {
          "filename": "TS4500_LOG_FB058_20190404101855.zip",
          "state": "inProgress",
          "startTime": "2019-04-04T10:18:55-0700",
          "lastUpdateTime": "2019-04-04T10:23:55-0700",
          "percentComplete": 61
     }, {
          "filename": "TS4500_LOG_FB058_20190403111344.zip",
          "state": "complete",
          "startTime": "2019-04-03T11:13:44-0700",
          "lastUpdateTime": "2019-04-03T11:25:55-0700",
          "percentComplete": 100
     }, {
          "filename": "TS4500_SS_0241_FB058_20230212170826.zip",
          "state": "complete",
          "startTime": 2023-02-12T17:08:26-0700,
          "lastUpdateTime": "2023-02-12T17:08:26-0700",
          "percentComplete": 100
     }, { 
          "filename": "TS4500_DriveLogs_F1C4R3_20230219112555.zip",
          "state": "complete",
          "startTime": 2023-02-19T11:25:55-0700,
          "lastUpdateTime": "2023-02-19T11:25:55-0700",
          "percentComplete": 100
     }, {
          . . .
     }
]

> GET /v1/logs
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 45992
[
     {
          "filename": "Diamondback_LOG_FB058_20190404101855.zip",
          "state": "inProgress",
          "startTime": "2019-04-04T10:18:55-0700",
          "lastUpdateTime": "2019-04-04T10:23:55-0700",
          "percentComplete": 61
     }, {
          "filename": "Diamondback_LOG_FB058_20190403111344.zip",
          "state": "complete",
          "startTime": "2019-04-03T11:13:44-0700",
          "lastUpdateTime": "2019-04-03T11:25:55-0700",
          "percentComplete": 100
     }, {
          "filename": "Diamondback_SS_0241_FB058_20230212170826.zip",
          "state": "complete",
          "startTime": 2023-02-12T17:08:26-0700,
          "lastUpdateTime": "2023-02-12T17:08:26-0700",
          "percentComplete": 100
     }, { 
          "filename": "Diamondback_DriveLogs_F1C4R3_20230219112555.zip",
          "state": "complete",
          "startTime": 2023-02-19T11:25:55-0700,
          "lastUpdateTime": "2023-02-19T11:25:55-0700",
          "percentComplete": 100
     }, {
          . . .
     }
]

Attributes

filename (string)

The name of the file.

state (string)

The write completion status of the log file. Values include:

State Description

inProgress

The task is in progress. The percentComplete attribute shows how far along the task is.

completed

The task completed successfully.

The file can be downloaded by using the GET /v1/logs/<filename>/export command.

failed

The task failed. Retry the operation. If it continues to fail, contact IBM Support.
startTime (string)

The time at which the log creation task started. Time format is YYYY-MM-DDThh:mm:ss±hh:mm

lastUpdatedTime (string)

The date of the last time the log file was modified. Time format is YYYY-MM-DDThh:mm:ss±hh:mm

percentComplete (number)

A percentage value accurate to one decimal place that shows how close the task is to being complete. This is an estimate of the time that the task takes and not actual time.