Dashboard:Get Local Zone Nodes

Search (SHIFT+S)




New in this release

Get Local Zone Nodes

GET /dashboard/zones/localzone/nodes

Gets the local vdc node details.


Query Parameters

pageNot implemented

Required Roles

Requires one of the following roles:

  • SYSTEM_MONITOR

  • SYSTEM_ADMIN


Response Body

Local VDC node details.


JSON Example

Request
GET https://192.168.0.0:4443/dashboard/zones/localzone/nodes.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/nodes"},
    },
    "_embedded": {
        "instances": [{
            "_links": {
                "self": { "href": "/dashboard/nodes/{node-id1}" },
                "disks": { "href": "/dashboard/{node-id1}/disks" },
                "processes": { "href": "/dashboard/nodes/{node-id1}/processes" }
            },
            "id": {node-id1},
            "displayName": {display-name},
             "numDisks": 8,
            "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",
            "numGoodDisks":40,
            "numSuspectDisks":10,
            "numBadDisks":10,
            "nodeCpuUtilization": [ {"t":"12345678" , "Percent ":10}, {"t":"23435455" , "Percent ":43}, {"t":"55433455" , "Percent ":39}],
            "nodeMemoryUtilizationBytes": [ {"t":"12345678" , "Bytes":10000}, {"t":"23435455" , " Bytes ":10000}, {"t":"55433455" , " Bytes ":10000}],
            "nodeMemoryUtilization": [ {"t":"12345678" , "Percent ":10}, {"t":"23435455" , "Percent ":43}, {"t":"55433455" , "Percent ":39}],
            "nodeNicBandwidth": [ {"t":"12345678" , " Bandwidth":1000}, {"t":"23435455" , " Bandwidth":4300}, {"t":"55433455" , " Bandwidth":"3009"}],
            "nodeNicUtilization": [ {"t":"12345678" , "Percent ":10}, {"t":"23435455" , "Percent ":43}, {"t":"55433455" , "Percent ":"39"}],
             "transactionReadLatency": [ {"t":"12345678" , "Latency":10000}, {"t":"23435455" , " Latency ":10000}, {"t":"55433455" , " Latency ":10000}],
             "transactionWriteLatency": [ {"t":"12345678" , "Latency":10000}, {"t":"23435455" , " Latency ":10000}, {"t":"55433455" , " Latency ":10000}],
             "transactionReadBandwidth": [ {"t":"12345678" , "Bandwidth":10000}, {"t":"23435455" , " Bandwidth ":10000}, {"t":"55433455" , " Bandwidth ":10000}],
             "transactionWriteBandwidth": [ {"t":"12345678" , " Bandwidth ":10000}, {"t":"23435455" , " Bandwidth ":10000}, {"t":"55433455" , " Bandwidth ":10000}],
             "transactionReadTransactionsPerSec": [ {"t":"12345678" , "TPS":10000}, {"t":"23435455" , " TPS ":10000}, {"t":"55433455" , " TPS ":10000}],
             "transactionWriteTransactionsPerSec ": [ {"t":"12345678" , " TPS ":10000}, {"t":"23435455" , " TPS ":10000}, {"t":"55433455" , " TPS ":10000}],
              "transactionErrors": {
                       "all": [ {"t":"12345678" , " Rate ":30}, {"t":"23435455" , " Rate ":0}, {"t":"55433455" , " Rate ":6}],
                       "types": [ {
                             "errorType": "NoConnection",
                             "errorRate":  [ {"t":"12345678" , " Rate ":10}, {"t":"23435455" , " Rate ":0}, {"t":"55433455" , " Rate ":2}]
                        }, {
                             "errorType": "InvalidAddress",
                             "errorRate":  [ {"t":"12345678" , " Rate ":10}, {"t":"23435455" , " Rate ":0}, {"t":"55433455" , " Rate ":2}]
                        }, {
                             "errorType": "ServerDown",
                             "errorRate":  [ {"t":"12345678" , " Rate ":10}, {"t":"23435455" , " Rate ":0}, {"t":"55433455" , " Rate ":2}]
                        } ]
             }
             "diskReadBandwidthTotal": [ {"t":"12345678" , "diskIO":10000}, {"t":"23435455" , " diskIO ":10000}, {"t":"55433455" , " diskIO ":10000}],
             "diskWriteBandwidthTotal": [ {"t":"12345678" , "diskIO":10000}, {"t":"23435455" , " diskIO ":10000}, {"t":"55433455" , " diskIO ":10000}],     
             "diskReadBandwidthEc": [ {"t":"12345678" , "diskIO":10000}, {"t":"23435455" , " diskIO ":10000}, {"t":"55433455" , " diskIO ":10000}],
             "diskWriteBandwidthEc": [ {"t":"12345678" , "diskIO":10000}, {"t":"23435455" , " diskIO ":10000}, {"t":"55433455" , " diskIO ":10000}],     
              "diskReadBandwidthCc": [ {"t":"12345678" , " diskIO ":10000}, {"t":"23435455" , " diskIO ":10000}, {"t":"55433455" , " diskIO ":10000}],
             "diskWriteBandwidthCc": [ {"t":"12345678" , " diskIO ":10000}, {"t":"23435455" , " diskIO ":10000}, {"t":"55433455" , " diskIO ":10000}],
              "diskReadBandwidthRecovery": [ {"t":"12345678" , " diskIO ":10000}, {"t":"23435455" , " diskIO ":10000}, {"t":"55433455" , " diskIO ":10000}],
              "diskWriteBandwidthRecovery": [ {"t":"12345678" , " diskIO ":10000}, {"t":"23435455" , " diskIO ":10000}, {"t":"55433455" , " diskIO ":10000}],
              "diskReadBandwidthGeo": [ {"t":"12345678" , " diskIO ":10000}, {"t":"23435455" , " diskIO ":10000}, {"t":"55433455" , " diskIO ":10000}],
              "diskWriteBandwidthGeo": [ {"t":"12345678" , " diskIO ":10000}, {"t":"23435455" , " diskIO ":10000}, {"t":"55433455" , " diskIO ":10000}],  
              "diskReadBandwidthUser": [ {"t":"12345678" , " diskIO ":10000}, {"t":"23435455" , " diskIO ":10000}, {"t":"55433455" , " diskIO ":10000}],
              "diskWriteBandwidthUser": [ {"t":"12345678" , " diskIO ":10000}, {"t":"23435455" , " diskIO ":10000}, {"t":"55433455" , " diskIO ":10000}],
              "diskReadBandwidthXor": [ {"t":"12345678" , " diskIO ":10000}, {"t":"23435455" , " diskIO ":10000}, {"t":"55433455" , " diskIO ":10000}],
          
        }, {
            "_links": {
                "self": { "href": "/dashboard/nodes/{node-id2}" },
                "disks": { "href": "/dashboard/nodes/{node-id2}/disks" },
               "processes": { "href": "/dashboard/nodes/{node-id2}/processes" }
            },
            "id": "node-id2",
            "displayName": "display-name",
            "numDisks": 8,
            "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",
            "numGoodDisks":40,
            "numSuspectDisks":10,
            "numBadDisks":10,

            "nodeCpuUtilization": [ {"t":"12345678" , "Percent ":10}, {"t":"23435455" , "Percent ":43}, {"t":"55433455" , "Percent ":39}],
            "nodeMemoryUtilizationBytes": [ {"t":"12345678" , "Bytes ":10000}, {"t":"23435455" , "Bytes ":10000}, {"t":"55433455" , "Bytes ":10000}],
            "nodeMemoryUtilization": [ {"t":"12345678" , "Percent":10}, {"t":"23435455" , "Percent ":43}, {"t":"55433455" , "Percent ":39}],
            "nodeNicBandwidth": [ {"t":"12345678" , " Bandwidth":1000}, {"t":"23435455" , " Bandwidth":4300}, {"t":"55433455" , " Bandwidth":"3009"}],
            "nodeNicUtilization": [ {"t":"12345678" , "Percent ":10}, {"t":"23435455" , "Percent ":43}, {"t":"55433455" , "Percent ":"39"}],
             "transactionReadLatency": [ {"t":"12345678" , "Latency":10000}, {"t":"23435455" , " Latency ":10000}, {"t":"55433455" , " Latency ":10000}],
             "transactionWriteLatency": [ {"t":"12345678" , "Latency":10000}, {"t":"23435455" , " Latency ":10000}, {"t":"55433455" , " Latency ":10000}],
             "transactionReadBandwidth": [ {"t":"12345678" , "Bandwidth":10000}, {"t":"23435455" , " Bandwidth ":10000}, {"t":"55433455" , " Bandwidth ":10000}],
             "transactionWriteBandwidth": [ {"t":"12345678" , " Bandwidth ":10000}, {"t":"23435455" , " Bandwidth ":10000}, {"t":"55433455" , " Bandwidth ":10000}],
             "transactionReadTransactionsPerSec": [ {"t":"12345678" , "TPS":10000}, {"t":"23435455" , " TPS ":10000}, {"t":"55433455" , " TPS ":10000}],
             "transactionWriteTransactionsPerSec ": [ {"t":"12345678" , " TPS ":10000}, {"t":"23435455" , " TPS ":10000}, {"t":"55433455" , " TPS ":10000}],
              "transactionErrors": {
                       "all": [ {"t":"12345678" , " Rate ":30}, {"t":"23435455" , " Rate ":0}, {"t":"55433455" , " Rate ":6}],
                       "types": [ {
                             "errorType": "NoConnection",
                             "errorRate":  [ {"t":"12345678" , " Rate ":10}, {"t":"23435455" , " Rate ":0}, {"t":"55433455" , " Rate ":2}]

                        }, {
                             "errorType": "InvalidAddress",
                             "errorRate":  [ {"t":"12345678" , " Rate ":10}, {"t":"23435455" , " Rate ":0}, {"t":"55433455" , " Rate ":2}]
                        }, {
                             "errorType": "ServerDown",
                             "errorRate":  [ {"t":"12345678" , " Rate ":10}, {"t":"23435455" , " Rate ":0}, {"t":"55433455" , " Rate ":2}]
                        } ]

             }
    
             "diskReadBandwidthTotal": [ {"t":"12345678" , "diskIO":10000}, {"t":"23435455" , " diskIO ":10000}, {"t":"55433455" , " diskIO ":10000}],
             "diskWriteBandwidthTotal": [ {"t":"12345678" , "diskIO":10000}, {"t":"23435455" , " diskIO ":10000}, {"t":"55433455" , " diskIO ":10000}],     
             "diskReadBandwidthEc": [ {"t":"12345678" , "diskIO":10000}, {"t":"23435455" , " diskIO ":10000}, {"t":"55433455" , " diskIO ":10000}],
             "diskWriteBandwidthEc": [ {"t":"12345678" , "diskIO":10000}, {"t":"23435455" , " diskIO ":10000}, {"t":"55433455" , " diskIO ":10000}],     
              "diskReadBandwidthCc": [ {"t":"12345678" , " diskIO ":10000}, {"t":"23435455" , " diskIO ":10000}, {"t":"55433455" , " diskIO ":10000}],
             "diskWriteBandwidthCc": [ {"t":"12345678" , " diskIO ":10000}, {"t":"23435455" , " diskIO ":10000}, {"t":"55433455" , " diskIO ":10000}],
              "diskReadBandwidthRecovery": [ {"t":"12345678" , " diskIO ":10000}, {"t":"23435455" , " diskIO ":10000}, {"t":"55433455" , " diskIO ":10000}],
              "diskWriteBandwidthRecovery": [ {"t":"12345678" , " diskIO ":10000}, {"t":"23435455" , " diskIO ":10000}, {"t":"55433455" , " diskIO ":10000}],
              "diskReadBandwidthGeo": [ {"t":"12345678" , " diskIO ":10000}, {"t":"23435455" , " diskIO ":10000}, {"t":"55433455" , " diskIO ":10000}],
              "diskWriteBandwidthGeo": [ {"t":"12345678" , " diskIO ":10000}, {"t":"23435455" , " diskIO ":10000}, {"t":"55433455" , " diskIO ":10000}],  
              "diskReadBandwidthUser": [ {"t":"12345678" , " diskIO ":10000}, {"t":"23435455" , " diskIO ":10000}, {"t":"55433455" , " diskIO ":10000}],
              "diskWriteBandwidthUser": [ {"t":"12345678" , " diskIO ":10000}, {"t":"23435455" , " diskIO ":10000}, {"t":"55433455" , " diskIO ":10000}],
              "diskReadBandwidthXor": [ {"t":"12345678" , " diskIO ":10000}, {"t":"23435455" , " diskIO ":10000}, {"t":"55433455" , " diskIO ":10000}],
              "diskWriteBandwidthXor": [ {"t":"12345678" , " diskIO ":10000}, {"t":"23435455" , " diskIO ":10000}, {"t":"55433455" , " diskIO ":10000}]
        }]

    }

}


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 this resource                                                  |    
------------------------------------+-----------+-----------------------------------------------------------------------+--------
url.self                            |           | URL to the node resource                                              |   
------------------------------------+-----------+-----------------------------------------------------------------------+-------- 
url.disks                           |           | URL to get data about all disks in the DAE associated with the node   |    
------------------------------------+-----------+-----------------------------------------------------------------------+--------
url.processes                       |           | URL to get data about major processes running on the node             |
------------------------------------+-----------+-----------------------------------------------------------------------+--------    
id                                  |           | Id of the node                                                        |
------------------------------------+-----------+-----------------------------------------------------------------------+--------
displayName                         |           | Name of the node                                                      |
------------------------------------+-----------+-----------------------------------------------------------------------+-------- 
numDisks                            |           | Number of disks in the DAE associated with the node                   |
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskSpaceTotal                      |Historical | Total  usable disk space across all disks in the DAE associated       |
                                    |           | with the node                                                         | Bytes
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskSpaceFree                       |Historical | Total  free usable disk space across all disks in the DAE             |
                                    |           | associated with the node                                              | Bytes
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskSpaceAllocated                  |Historical | Total  disk space allocated for chunks across all disks in the        |
                                    |           | DAE associated with the node                                          | Bytes
------------------------------------+-----------+-----------------------------------------------------------------------+--------
healthStatus                        |           | Status of the node - Good, Suspect or Bad                             |
------------------------------------+-----------+-----------------------------------------------------------------------+-------- 
numGoodDisks                        |           | Number of disks with a Good status in the DAE associated              |
                                    |           | with the node                                                         |
------------------------------------+-----------+-----------------------------------------------------------------------+--------    
numSuspectDisks                     |           | Number of disks with a Suspect status in the DAE associated           |
                                    |           | with the node                                                         |
------------------------------------+-----------+-----------------------------------------------------------------------+--------    
numBadDisks                         |           | Number of disks with a Bad status in the DAE associated with          |
                                    |           | the node                                                              |
------------------------------------+-----------+-----------------------------------------------------------------------+-------- 
nodeCpuUtilization                  |           | Percentage of the node CPU time spent non-kernel (user+nice) and      |
                                    |           | kernel (system) code relatively to total CPU time of all cores and    |
                                    |           | processors installed on the node.                                     |Percent
------------------------------------+-----------+-----------------------------------------------------------------------+--------
nodeMemoryUtilizationBytes          |           | Amount of RAM used on the node excluding buffered and cached space.   | Bytes
------------------------------------+-----------+-----------------------------------------------------------------------+--------
nodeMemoryUtilization               |           | Amount of RAM used on the node relativeley to the total RAM size.     | Percent
------------------------------------+-----------+-----------------------------------------------------------------------+--------
nodeNicBandwidth                    |           | Amount of data transferred through NIC cards on this node per second. | MB/s
------------------------------------+-----------+-----------------------------------------------------------------------+--------
nodeNicUtilization                  |           | Amount of data transferred through NIC cards on this node per second  |
                                    |           |  relatively to maximum capacity.                                      | Percent
------------------------------------+-----------+-----------------------------------------------------------------------+--------
transactionReadLatency              |Historical | Average amount of time taken to process read transactions.            | ms
------------------------------------+-----------+-----------------------------------------------------------------------+--------
transactionWriteLatency             |Historical | Average amount of time taken to process write transactions.           | ms
------------------------------------+-----------+-----------------------------------------------------------------------+--------
transactionReadBandwidth            |Historical | Average amount of data returned in read transactions per second       |
                                    |           | over the previous interval                                            | MB/s
------------------------------------+-----------+-----------------------------------------------------------------------+--------
transactionWriteBandwidth           |Historical | Average amount of data received in write transactions per second      |
                                    |           | over the previous interval                                            | MB/s
------------------------------------+-----------+-----------------------------------------------------------------------+--------
transactionReadTransactionsPerSec   |Historical | Average number of read transactions requested per second over         |
                                    |           | the previous interval                                                 | TPS
------------------------------------+-----------+-----------------------------------------------------------------------+--------
transactionWriteTransactionsPerSec  |Historical | Average number of write transactions requested per second over        |
                                    |           | the previous interval                                                 |TPS
------------------------------------+-----------+-----------------------------------------------------------------------+--------
transactionErrors.all               |Historical | Percentage of failed transactions per second over                     |
                                    |           | the previous interval                                                 | Percent
------------------------------------+-----------+-----------------------------------------------------------------------+--------
transactionErrors.types.errorType   |           | Type of Error, e.g. <add examples>                                    |
------------------------------------+-----------+-----------------------------------------------------------------------+--------    
transactionErrors.types.errorRate   |Historical | Percentage of failed transactions with this error Type                |
                                    |           | per second over the previous interval. Historical data for specific   |
                                    |           | error types includes only snapshots for the intervals when this error |
                                    |           | type occurs at least once during the previous interval.               | Percent
                                    |           | For example, of error 201 occurred between 8-9am, 1-2pm and now is    |
                                    |           | 7pm, only 2 snapshot intervals will be reported in historical series  |
                                    |           | for error 201 with timestamps corresponding to 9am and 2pm.           |
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskReadBandwidthTotal              |Historical | Average amount of data read from disks per second                     | MB/s
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskWriteBandwidthTotal             |Historical | Average amount of data written to disks per second                    | MB/s
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskReadBandwidthEc                 |Historical | Average amount of data read from disks for Erasure Coding per second  | MB/s
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskWriteBandwidthEc                |Historical | Average amount of data written to disks for Erasure Coding per second | MB/s
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskReadBandwidthCc                 |Historical |Average amount of data read from disks for Consistency Check per second| MB/s
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskWriteBandwidthCc                |Historical |Average amount of data written to disks for Consistency Check per second| MB/s
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskReadBandwidthRecovery           |Historical | Average amount of data read from disks for Recovery per second        | MB/s
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskWriteBandwidthRecovery          |Historical | Average amount of data written to disks for Recovery per second       | MB/s
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskReadBandwidthGeo                |Historical | Average amount of data read from disks for Geo Replication per second | MB/s
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskWriteBandwidthGeo               |Historical | Average amount of data written to disks for Geo Replication per second| MB/s
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskReadBandwidthUser               |Historical | Average amount of data read from disks for User data per second       | MB/s
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskWriteBandwidthUser              |Historical | Average amount of data written to disks for User Data per second      | MB/s
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskReadBandwidthXor                |Historical | Average amount of data read from disks for XOR operations per second  | MB/s
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskWriteBandwidthXor               |Historical | Average amount of data written to disks for XOR operations per second | MB/s
------------------------------------+-----------+-----------------------------------------------------------------------+--------
Notes: