Get drive reports

Edit online

The drive report contains the usage history for each drive, including mounts, cleans, host I/O, compression rate, error rates, and environmental data. These reports are taken at intervals of one hour and kept for one year. However, you can offload only one week of data at a time by using the GET command to ensure the query response size does not get too large. If you do not include query parameters to limit the time frame, all reports for the last week will be returned.

Important Note

The tape drive temperature and humidity sensors measure the environment AFTER the air has been moved through the drive and heated. The drive sensors can be used by the drive to self-protect in extreme conditions and to detect the POSSIBILITY of non-compliant ambient temperature or humidity (by way of correlation). However, the drive sensors are NOT a measurement of the customer ambient environment.

Request syntax

GET /v1/reports/drives
Retrieves all reports for the last week.

Query parameters

after (string, optional): The time after which reports should be viewed. Any report with a time matching or before this time will not be returned. Time format is YYYY-MM-DDThh:mm:ss±hh:mm. This defaults to the current date and time of the library.
before (string, optional): The time before which reports should be viewed. Any report with a time matching or after this time will not be returned. Time format is YYYY-MM-DDThh:mm:ss±hh:mm. This defaults to one week ago.

Example

> GET /v1/reports/drives?after=2019-04-03T00:00:00&before=2019-04-04T00:00:00
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1903

[
     {
          "location": "drive_F4C0R1",
          "sn": "YD1097000039",
          "time": "2019-04-03T11:13:44-0700",
          "duration": "3600",
          "mounts": 41,
          "cleans": 0,
          "dataReadByHost": 3584,
          "dataWrittenByHost": 408905,
          "dataWrittenToCartridges": 4089050,
          "errorsCorrectedRead": 0,
          "errorsCorrectedWrite": 0,
          "errorsUncorrected": 0,
          "temperatureAverage": 24.1,
          "temperatureMin": 24.0,
          "temperatureMax": 25.0,
          "humidityAverage": 24.1,
          "humidityMin": 24.0,
          "humidityMax": 25.0
     }, {
          . . .
     }
]

Attributes

location (string): The unique location of the drive.
sn (string): The globally unique serial number of the drive.
time (string): The time at which this data entry was recorded. Time format is YYYY-MM-DDThh:mm:ss±hh:mm.
duration (number): The number of seconds this data entry was recorded over.
mounts (number): The number of cartridges that are mounted to the drive over the duration.
cleans (number): The number of times the drive was cleaned the duration. Before library firmware version 1.7.0.1-D00, the value of this attribute is always 0.
dataReadByHost (number): The number of MB of data that is read by the drive from the cartridge over the duration.
dataWritenByHost (number): The number of MB of data that is written by the drive to the cartridge over the duration.
dataWrittenToCartridges (number): The number of MB of data that is written to the cartridges by the drive over the duration. The average compression ratio can be found by dividing dataWritenByHosts by dataWrittenToCartridge.
errorsCorrectedRead (number): The number of corrected read errors on the drive over the duration.
errorsCorrectedWrite (number): The number of corrected write errors on the drive over the duration.
errorsUncorrected (number): The number of uncorrected errors on the drive over the duration.
temperatureAverage (number): The average temperature in Celsius of the drive over the duration, accurate to one decimal place. This is not a measurement of the ambient environment.
temperatureMin (number): The minimum temperature in Celsius of the drive over the duration, accurate to one decimal place. This is not a measurement of the ambient environment.
temperatureMax (number): The maximum temperature in Celsius of the drive over the duration, accurate to one decimal place. This is not a measurement of the ambient environment.
humidityAverage (number): The average percent humidity in the drive over the duration, accurate to one decimal place. This is not a measurement of the ambient environment.
humidityMin (number): The minimum percent humidity in the drive over the duration, accurate to one decimal place. This is not a measurement of the ambient environment.
humidityMax (number): The minimum percent humidity in the drive over the duration, accurate to one decimal place. This is not a measurement of the ambient environment.