Skip to main content

GET /api/v1/data/devices/{id}/storage

Use this method to return storage information for a specific device.

Authentication​

Authentication with user name and password is required.

Resource URI​

GET https://{orchestrator_server_IP}/api/v1/data/devices/{id}/storage

where {id} is the ID of the device. To obtain the device IDs, use GET /api/v1/data/devices.

Query parameters​

None

Request body​

None

Response codes​

CodeDescriptionComments
200OKThe request completed successfully.
404Not foundThe resource cannot be found. A descriptive error message is returned in the response body.

Response body​

When the request is successful, the following attributes are returned. If the request fails, standard message attributes are returned (see Status messages).

AttributesTypeDescription
bayStringBay or slot number
blockSizeIntegerBlock size
capacityInteger(M.2 drives only) Storage capacity, in KB
descriptionStringDescription
diskStateStringDisk-drive state
firmwareArray of objectsInformation about add-in card firmware
 buildStringFirmware build
 classificationsArray of integersFirmware type codes
 dateStringFirmware date
 nameStringFirmware name
 revisionStringFirmware revision
 roleStringFirmware role. This can be one of the following values.
  • Primary
  • Backup
  • Temporary
  • Permanent
 softwareID Firmware ID
 statusStringFirmware status. This can be one of the following values.
  • Active
  • Inactive
 typeStringFirmware type, such as UEFI, MP, or DSA
 versionStringFirmware version
FRUStringFRU
healthStateStringHealth state (translated) that corresponds to the highest event severity of all disk drives in the device. This can be one of the following values.
  • Normal
  • Non-Critical
  • Warning
  • Minor-Failure
  • Major-Failure
  • Non-Recoverable
  • Critical
  • Unknown
ealthStateKeyStringHealth state key that corresponds to the highest event severity of all disk drives in the device. This can be one of the following values.
  • Normal
  • Non-Critical
  • Warning
  • Minor-Failure
  • Major-Failure
  • Non-Recoverable
  • Critical
  • Unknown
interfaceTypeStringInterface type
largestAvailableSizeInteger 
m2LocationString(M.2 drives only) Location of M.2 drive and bay
manufacturerStringManufacturer
mediaTypeStringMedia type
modelStringModel
nameStringDrive name
numberOfBlocksIntegerNumber of blocks
partNumberStringPart number
remainingLifeIntegerIndicate the amount of life that remains for a solid-state drive (SSD). This can be one of the following values.
  • 0 - 100. The percent of remaining life
  • -1. Unknown (default)
  • -2. Information is not available
  • -3. The drive is not an SSD
serialNumberStringSerial number
temperatureIntegerDevice temperature
uuidStringStorage device UUID
_linksObjectDevice URI (see Links)
The following example is returned if the request is successful.
[{
   "bay": 3,
   "blockSize": 512,
   "capacity": 1000204886000,
   "description": "ST1000NX0453",
   "diskState": "JBOD",
   "firmware": [{
      "name": "Drive",
      "date": "",
      "type": "Firmware",
      "build": "0",
      "version": "LD4B",
      "role": "Primary",
      "status": "Active",
      "classifications": [10],
      "revision": "0",
      "softwareID": "ST1000NX0453",
      "deviceTypeKey": "firmware"
   }],
   "FRU": "00YK023",
   "healthState": "Normal",
   "healthStateKey": "Normal",
   "interfaceType": "SAS",
   "largestAvailableSize": 512,
   "m2Location": "",
   "manufacturer": "LENOVO",
   "mediaType": "Rotational",
   "model": "ST1000NX0453",
   "name": "Disk 3_a",
   "numberOfBlocks": 1953525168,
   "partNumber": "D7A01872",
   "remainingLife": null,
   "serialNumber": "W470TAY4",
   "temperature": 34,
   "uuid": ""
},
...,
{
   "bay": 0,
   "blockSize": 512,
   "capacity": 1000204886000,
   "description": "ST1000NX0453",
   "diskState": "JBOD",
   "firmware": [{
      "name": "Drive",
      "date": "",
      "type": "Firmware",
      "build": "0",
      "version": "LD4B",
      "role": "Primary",
      "status": "Active",
      "classifications": [10],
         "revision": "0",
      "softwareID": "ST1000NX0453",
      "deviceTypeKey": "firmware"
   }],
   "FRU": "00YK023",
   "healthState": "Normal",
   "healthStateKey": "Normal",
   "interfaceType": "SAS",
   "largestAvailableSize": 512,
   "m2Location": "",
   "manufacturer": "LENOVO",
   "mediaType": "Rotational",
   "model": "ST1000NX0453",
   "name": "Disk 0_b",
   "numberOfBlocks": 1953525168,
   "partNumber": "D7A01872",
   "remainingLife": null,
   "serialNumber": "W470MBJD",
   "temperature": 33,
   "uuid": ""
}]