Dashboard:Get Local Zone Storage Pools

Search (SHIFT+S)




New in this release

Get Local Zone Storage Pools

GET /dashboard/zones/localzone/storagepools

Gets the local VDC storage pool details.


Required Roles

Requires one of the following roles:

  • SYSTEM_MONITOR

  • SYSTEM_ADMIN


Response Body

Local VDC storage pool details.


JSON Example

Request
GET https://192.168.0.0:4443/dashboard/zones/localzone/storagepools.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/zones/localzone/storagepools "},
    },
    "_embedded": {
        "instances": [{
            "_links": {
                "self": { "href": "/dashboard/storagepools/{sp-id1}" },
                "nodes": { "href": "/dashboard/storagepools/{sp-id1}/nodes" },
            },                                                                          
            "id": "sp-id1",
            "name": "sp_name",
            "numNodes": 8,
            "numDisks": 64,

            "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}],

            "numGoodNodes": 15,
            "numSuspectNodes": 0, 
            "numBadNodes": 1,

            "chunksRepoNumber":1000,
            "chunksRepoTotalSealSize":5000000,
            "chunksRepoAvgSealSize":5000000,
            "chunksL0BtreeNumber":1000,
            "chunksL0BtreeTotalSize":5000000,
            "chunksL0BtreeAvgSize":5000000,
            "chunksL0JournalNumber":1000,
            "chunksL0JournalTotalSize":5000000,
            "chunksL0JournalAvgSize":5000000,
            "chunksL1BtreeNumber":1000,
            "chunksL1BtreeTotalSize":5000000,
            "chunksL1BtreeAvgSize":5000000,
            "chunksL1JournalNumber":1000,
            "chunksL1JournalTotalSize":5000000,
            "chunksL1JournalAvgSize":5000000,
            "chunksGeoCopyNumber":1000,
            "chunksGeoCopyTotalSize":5000000,
            "chunksGeoCopyAvgSize":5000000,
            "chunksXorNumber":1000,
            "chunksXorTotalSize":5000000,
            "chunksXorAvgSize":5000000,
            "chunksRepoTotalSealSizeHistory": [ {"t":"12345678" , "Space":500}, {"t":"23435455" , " Space ":300}, {"t":"55433455" , " Space ":400}],
            "chunksEcCodedTotalSealSizeHistory": [ {"t":"12345678" , "Space":500}, {"t":"23435455" , " Space ":300}, {"t":"55433455" , " Space ":400}],
            "chunksEcApplicableTotalSealSizeHistory":  [ {"t":"12345678" , "Space":500}, {"t":"23435455" , " Space ":300}, {"t":"55433455" , " Space ":400}],
            "chunksEcCodedRatio": [ {"t":"12345678" , "Percent":50.1}, {"t":"23435455" , " Percent ":90.5}, {"t":"55433455" , " Percent ":98.7}],
            "chunksEcRate": [ {"t":"12345678" , "Rate":500}, {"t":"23435455" , "Rate":300}, {"t":"55433455" , "Rate":400}],
            "chunksEcCompleteTimeEstimate": 235,

            "recoveryBadChunksTotalSize": [ {"t":"12345678" , "Space":500}, {"t":"23435455" , " Space ":300}, {"t":"55433455" , " Space ":400}],
            "recoveryRate": [ {"t":"12345678" , "Rate":500}, {"t":"23435455" , "Rate":300}, {"t":"55433455" , "Rate":400}],
            "recoveryCompleteTimeEstimate": 235

        }, {
            "_links": {
                "self": { "href": "/dashboard/storagepools/{sp-id2}" },
                "nodes": { "href": "/dashboard/storagepools/{sp-id2}/nodes" },
            },
            "id": "sp-id2",
            "name": "sp_name",
            "numNodes": 8,
            "numDisks": 64,

            "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}],

            "numGoodNodes": 15,
            "numSuspectNodes": 0, 
            "numBadNodes": 1,

            "chunksRepoNumber":1000,
            "chunksRepoTotalSealSize":5000000,
            "chunksRepoAvgSealSize":5000000,
            "chunksL0BtreeNumber":1000,
            "chunksL0BtreeTotalSize":5000000,
            "chunksL0BtreeAvgSize":5000000,
            "chunksL0JournalNumber":1000,
            "chunksL0JournalTotalSize":5000000,
            "chunksL0JournalAvgSize":5000000,
            "chunksL1BtreeNumber":1000,
            "chunksL1BtreeTotalSize":5000000,
            "chunksL1BtreeAvgSize":5000000,
            "chunksL1JournalNumber":1000,
            "chunksL1JournalTotalSize":5000000,
            "chunksL1JournalAvgSize":5000000,
            "chunksGeoCopyNumber":1000,
            "chunksGeoCopyTotalSize":5000000,
            "chunksGeoCopyAvgSize":5000000,
            "chunksXorNumber":1000,
            "chunksXorTotalSize":5000000,
            "chunksXorAvgSize":5000000,
            "chunksRepoTotalSealSizeHistory": [ {"t":"12345678" , "Space":500}, {"t":"23435455" , " Space ":300}, {"t":"55433455" , " Space ":400}],
            "chunksEcCodedTotalSealSizeHistory": [ {"t":"12345678" , "Space":500}, {"t":"23435455" , " Space ":300}, {"t":"55433455" , " Space ":400}],
            "chunksEcApplicableTotalSealSizeHistory":  [ {"t":"12345678" , "Space":500}, {"t":"23435455" , " Space ":300}, {"t":"55433455" , " Space ":400}],
            "chunksEcCodedRatio": [ {"t":"12345678" , "Percent":50.1}, {"t":"23435455" , " Percent ":90.5}, {"t":"55433455" , " Percent ":98.7}],
            "chunksEcRate": [ {"t":"12345678" , "Rate":500}, {"t":"23435455" , "Rate":300}, {"t":"55433455" , "Rate":400}],
            "chunksEcCompleteTimeEstimate": 235,

            "recoveryBadChunksTotalSize": [ {"t":"12345678" , "Space":500}, {"t":"23435455" , " Space ":300}, {"t":"55433455" , " Space ":400}],
            "recoveryRate": [ {"t":"12345678" , "Rate":500}, {"t":"23435455" , "Rate":300}, {"t":"55433455" , "Rate":400}],
            "recoveryCompleteTimeEstimate": 235
        }]

    }

}

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                                                  |
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
url.self                                 |           | 	      |URL to the+C114 storage pool resource                                 |
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
url.nodes                                |           | 	      |URL to get data about all nodes in this storage pool                  |
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
id                                       |           | 	      |ID of the storage pool                                                |
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
name                                     |           | 	      |Name of the storage pool                                              |
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
numNodes                                 |           | 	      |Number of nodes in the storage pool                                   |            
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
numDisks                                 |           | 	      |Total number of disks across nodes in the storage pool                |    
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
diskSpaceTotal                           |Historical |capacity|Total usable disk space across all nodes in the storage pool          |    
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
diskSpaceFree                            |Historical |capacity|Total free usable disk space across all nodes in the storage pool     |
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
diskSpaceAllocated                       |Historical |capacity|Total usable disk space across all nodes in the storage pool          |        
                                         |           | 	      |allocated for chunks                                                  |
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
numGoodNodes                             |           |health  |Number of nodes in the storage pool with Good state                   |            
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
numSuspectNodes                          |           |health  |Number of nodes in the storage pool with Suspect state                |                
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
numBadNodes                              |           |health  |Number of nodes in the storage pool with Bad state                    |                    
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
chunksRepoNumber                         |           |chunks  |Number of Repo chunks in the storage pool                             |                            
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
chunksRepoTotalSealSize                  |           |chunks  |Total seal size of all repo chunks in the storage pool                | Bytes
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
chunksRepoAvgSealSize                    |           |chunks  |Average seal size of repo chunks in the storage pool                  | Bytes
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
chunksL0BtreeNumber                      |           |chunks  |Number of L0 Btree chunks in the storage pool                         |                        
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
chunksL0BtreeTotalSize                   |           |chunks  |Total seal size of all L0 Btree chunks in the storage pool            | Bytes
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
chunksL0BtreeAvgSize                     |           |chunks  |Average seal size of L0 Btree chunks in the storage pool              | Bytes
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
chunksL0JournalNumber                    |           |chunks  |Number of L0 Journal chunks in the storage pool                       |
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
chunksL0JournalTotalSize                 |           |chunks  |Total seal size of all L0 Journal chunks  in the storage pool         | Bytes
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
chunksL0JournalAvgSize                   |           |chunks  |Average seal size of L0 Journal chunks in the storage pool            | Bytes
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
chunksL1BtreeNumber                      |           |chunks  |Number of L1 Btree chunks in the storage pool                         |                        
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
chunksL1BtreeTotalSize                   |           |chunks  |Total seal size of all L1 Btree chunks in the storage pool            | Bytes
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
chunksL1BtreeAvgSize                     |           |chunks  |Average seal size of L1 Btree chunks in the storage pool              | Bytes
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
chunksL1JournalNumber                    |           |chunks  |Number of L1 Journal chunks in the storage pool                       |                    
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
chunksL1JournalTotalSize                 |           |chunks  |Total seal size of all L1 Journal chunks  in the storage pool         | Bytes
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
chunksL1JournalAvgSize                   |           |chunks  |Average seal size of L1 Journal chunks in the storage pool            | Bytes
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
chunksGeoCopyNumber                      |           |chunks  |Number of Geo Copy chunks in the storage pool                         |            
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
chunksGeoCopyTotalSize                   |           |chunks  |Total seal size of all Geo Copy chunks in the storage pool            | Bytes
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
chunksGeoCopyAvgSize                     |           |chunks  |Average seal size of  Geo Copy chunks in the storage pool             | Bytes
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
chunksXorNumber                          |           |chunks  |Number of XOR chunks in the storage pool                              | 
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
chunksXorTotalSize                       |           |chunks  |Total seal size of all XOR chunks  in the storage pool                | Bytes
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
chunksXorAvgSize                         |           |chunks  |Average seal size of  XOR chunks in the storage pool                  | Bytes
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
chunksRepoTotalSealSizeHistory           |Historical |chunks  |Total seal size of all repo chunks in the storage pool                | Bytes
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
chunksEcCodedTotalSealSizeHistory        |Historical |chunks  |Total seal size of Erasure Coded chunks in the storage pool           | Bytes
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
chunksEcApplicableTotalSealSizeHistory   |Historical |chunks  |Total seal size of the chunks in the storage pool that are -          | Bytes
                                         |           | 	      |applicable / subject to Erasure Coding ( Repo + GeoCopy + XOR ).      | 
                                         |           | 	      |This includes both already Erasure Coded and pending Erasure Coding chunks| 
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
chunksEcCodedRatio                       |Historical |chunks  |Ratio of total space of Erasure Coded chunks to total space of all    |
                                         |           |	      |chunks subject to Erasure Coding (Repo + GeoCopy + XOR)               | Percent
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
chunksEcRate                             |Historical |chunks  |Average amount of data being erasure coded per second over the        |
                                         |           | 	      |previous interval                                                     | MB/s                                  
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
chunksEcCompleteTimeEstimate             |           |chunks  |Estimated time required for Erasure Coding of the currently EC        |
                                         |           | 	      |pending chunks.                                                       | seconds
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
recoveryBadChunksTotalSize               |Historical |chunks  |Total size of the bad chunks to be recovered.                         | Bytes
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
recoveryRate                             |Historical |chunks  |Average amount of chunks data recovered per second over the previous  |
                                         |           | 	      |interval                                                              | MB/s
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
recoveryCompleteTimeEstimate             |           |chunks  |Estimated time required for recover current bad chunks.               |
-----------------------------------------+-----------+-------------------------------------------------------------------------------+--------
Notes: