Skip to main content

GetDiskInfo

Retrieves disk/storage information including capacity, free space, and status.

Endpoint

FieldValue
MethodPOST or GET
URLhttp://<host>[:port]/GetDiskInfo
ProductsIPC, NVR
Channel IDN/A

Response Fields

FieldTypeDescription
idstringDisk identifier
totalSpaceuint32Total disk capacity in MB
freeSpaceuint32Available space in MB
imageFreeSpaceuint32Free space for image storage in MB (IPC only)
statusdiskStatusCurrent disk status
storageTypediskTypeStorage type: SD or HDD (v2.0 only)

Disk Status Values

StatusDescription
readRead-only mode
read/writeNormal read/write operation
unformatDisk is unformatted
formattingDisk is currently being formatted
exceptionDisk error
lockedDisk is locked (v2.0 only)

Response (v2.0 IPC)

<?xml version="1.0" encoding="UTF-8"?>
<config version="2.0.0" xmlns="http://www.ipc.com/ver10">
<types>
<diskStatus>
<enum>read</enum>
<enum>read/write</enum>
<enum>unformat</enum>
<enum>formatting</enum>
<enum>exception</enum>
<enum>locked</enum>
</diskStatus>
</types>
<diskInfo type="list" count="1">
<item>
<id type="string"><![CDATA[disk1]]></id>
<totalSpace type="uint32">30371</totalSpace>
<freeSpace type="uint32">0</freeSpace>
<imageFreeSpace type="uint32">2985</imageFreeSpace>
<status type="diskStatus">read/write</status>
<storageType type="diskType">SD</storageType>
</item>
</diskInfo>
</config>

Response (v1.9)

<?xml version="1.0" encoding="UTF-8"?>
<config version="1.0" xmlns="http://www.ipc.com/ver10">
<types>
<diskStatus>
<enum>read</enum>
<enum>read/write</enum>
<enum>unformat</enum>
<enum>formatting</enum>
<enum>exception</enum>
</diskStatus>
</types>
<diskInfo type="list" count="1">
<item>
<id type="string"><![CDATA[{5B457B2A-D467-834E-B1E8-22F3450DA873}]]></id>
<totalSpace type="uint32">953869</totalSpace>
<freeSpace type="uint32">847872</freeSpace>
<imageFreeSpace type="uint32">847872</imageFreeSpace>
<diskStatus type="diskStatus">read/write</diskStatus>
</item>
</diskInfo>
</config>

Notes

  • totalSpace and freeSpace are in megabytes (MB).
  • If no disk is present, the diskInfo node will be empty.
  • imageFreeSpace is IPC only.
v2.0 Changes

v2.0 adds storageType (SD/HDD) and locked disk status.