Dashboard:Get Disk

Search (SHIFT+S)




New in this release

Get Disk

GET /dashboard/disks/{id}

Gets the disk instance details.

iddisk identifier

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
======================

a. All Time Stamps are GMT Epoch time in seconds.
b. Numbers can be reported in different formats, including without decimal point (e.g. 23000000), with decimal point (23000000.0) or exponential (2.3e7)
c. <Attribute>Current : Most current value of an attribute. Attribute is returned in the form of a single snapshot {"t":12345678, " 'value tag' ":10} where value reports the most                               recently known value of the attribute and timestamp 't' reports time for which this value is available. The value tag is the same as used for the original                                historical attribute. Units of the reported current value are the same as units of the relevant Xyz attribute.
d. <Attribute>Summary : Reporting summary values for a historical attribute which includes Min (lowest),(highest) and Avg (average) values across all snapshots. Attribute is returned in                        the for of { "Min" : {"t":"12345678" , "Percent":10}, "Max" : {"t":"23435455" , "Percent":43}, "Avg" : 30.67 }. The value tag is the same as used for the original                        historical attribute. Units of the reported current value are the same as units of the relevant Xyz attribute.
e. <Attribute> Current / Summary values will be available only for Historical attributes.
f. 'dataType' filter  : The client can use this filter to which data needs to be returned in the feed. If not supplied all that will be returned.
			dataType=current : to return only the Current values, as detailed in Point C.
			dataType=historical&starTime=<Time>&endTime=<Time>&interval=<Interval in seconds>  : to return historical series data and summary for the period specified.
			Start and End Times are in Epoch Time in Seconds.
g. 'category' filter  : Every API can be called with an optional 'category' filter. This filter specifies the category of data to be included in the API. It is recommended to use filters			  only when a subset of the attributes is necessary.
h. Starting from ECS 2.2 a new variable named "apiChange' will be returned with every Dashboard api call to allow api consumers to collect data from different ECS versions and react to any new or modified metrics that are returned.

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