Dashboard:Get Storage Pool

Search (SHIFT+S)




New in this release

Get Storage Pool

GET /dashboard/storagepools/{id}

Gets the storage pool details.

idStorage pool identifier

Query Parameters

pageNot implemented

Required Roles

Requires one of the following roles:

  • SYSTEM_MONITOR

  • SYSTEM_ADMIN


Response Body

Storage pool details


JSON Example

Request
GET https://192.168.0.0:4443/dashboard/storagepools/sp-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/storagepools/{sp-id}" },
                "nodes": { "href": "/dashboard/storagepools/{sp-id}/nodes" },
            },                                                                          
            "id": "sp-id",
            "name": "sp_name",
           "numNodes": 8,
            "numDisks": 64,
            "diskSpaceTotal": [ {"t":"12345678" , "Space":500},numGoodNodes {"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)

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