Dashboard:Get Disk

Search (SHIFT+S)




New in this release

Get Disk

GET /dashboard/disks/{id}

Gets the disk instance details.

id

Query Parameters

pageNot implemented

Required Roles

Requires one of the following roles:

  • SYSTEM_MONITOR

  • SYSTEM_ADMIN


Response Body

Disk instance details.


JSON Example

Request
GET https://192.168.0.0:4443/dashboard/disks/disk-id.json HTTP/1.1

Content-Type: application/json
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
Response
HTTP/1.1 200 OK
Content-Type: application/json

{

    "_links": {

        "self": { "href": "/dashboard/disks/{disk-id}"}

    },

    "id": "disk-id", 

    "displayName": disk-id,

    "diskSpaceTotal": [ {"t":"12345678" , "Space":500}, {"t":"23435455" , " Space ":500}, {"t":"55433455" , " Space ":500}],

    "diskSpaceFree": [ {"t":"12345678" , "Space":100}, {"t":"23435455" , " Space ":100}, {"t":"55433455" , " Space ":50}],

    "diskSpaceAllocated": [ {"t":"12345678" , "Space":400}, {"t":"23435455" , " Space ":400}, {"t":"55433455" , " Space ":450}],

    "healthStatus": "Good"
}

ATTRIBUTES DESCRIPTION
======================

Numbers can be reported in different formats, including without decimal point (e.g. 23000000), with decimal point (23000000.0) or exponential (2.3e7)

-----------------------------------+-----------+---------------------------------------------------------------------+--------  
Attribute                          |Historical?|                          Description                                |Units
-----------------------------------+-----------+---------------------------------------------------------------------+--------  
url.self                           |           |  URL to this resource                                               |
-----------------------------------+-----------+---------------------------------------------------------------------+--------  
id                                 |           |  id of the disk                                                     | 
-----------------------------------+-----------+---------------------------------------------------------------------+--------  
displayName                        |           |  Name of the disk                                                   |
-----------------------------------+-----------+---------------------------------------------------------------------+--------  
diskSpaceTotal                     |Historical |  Total usable space on the disk                                     |Bytes
-----------------------------------+-----------+---------------------------------------------------------------------+--------  
diskSpaceFree                      |Historical |  Total usable space on the disk                                     |Bytes
-----------------------------------+-----------+---------------------------------------------------------------------+-------- 
diskSpaceAllocated                 |Historical |  Total usable space on the disk                                     |Bytes
-----------------------------------+-----------+---------------------------------------------------------------------+-------- 
healthStatus                       |           |  Status of the disk - Good, Suspect or Bad                          |
-----------------------------------+-----------+---------------------------------------------------------------------+--------
Notes: