Dashboard:Get Local Zone

Search (SHIFT+S)




New in this release

Get Local Zone

GET /dashboard/zones/localzone

Gets the local VDC details


Query Parameters

pageNot implemented

Required Roles

Requires one of the following roles:

  • SYSTEM_MONITOR

  • SYSTEM_ADMIN


Response Body

Local VDC details


JSON Example

Request
GET https://192.168.0.0:4443/dashboard/zones/localzone.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": { "href": "/dashboard/zones/localzone/storagepools" },
        "nodes": { "href": "/dashboard/zones/localzone/nodes" },
        "replicationgroups": { "href": "/dashboard/zones/localzone/replicationgroups" },
        "rglinksFailed": { "href": "/dashboard/zones/localzone/rglinksFailed" },
        "rglinksBootstrap": { "href": "/dashboard/zones/localzone/rglinksBootstrap"  }
     },

    "name": "vdc1",
    "numNodes":16,

     "nodeCpuUtilizationAvg": [ {"t":"12345678" , "Percent":10}, {"t":"23435455" , "Percent":43}, {"t":"55433455" , "Percent":39}],
     "nodeMemoryUtilizationBytesAvg": [ {"t":"12345678" , "Bytes ":10000}, {"t":"23435455" , "Bytes ":10000}, {"t":"55433455" , "Bytes ":10000}],
     "nodeMemoryUtilizationAvg": [ {"t":"12345678" , " Percent ":10}, {"t":"23435455" , " Percent ":43}, {"t":"55433455" , " Percent ":39}],
     "nodeNicBandwidthAvg": [ {"t":"12345678" , " Bandwidth":1000}, {"t":"23435455" , " Bandwidth":4300}, {"t":"55433455" , " Bandwidth":"3009"}],
     "nodeNicUtilizationAvg": [ {"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}],

       "replicationRpoTimestamp": 12345678
}


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.storagepools                   |           |  URL to get data about all storage pools in this zone               | 
-----------------------------------+-----------+---------------------------------------------------------------------+--------  
url.nodes                          |           |  URL to get data about all nodes in this zone                       |
-----------------------------------+-----------+---------------------------------------------------------------------+--------  
url.replicationgroups              |           |  URL to get data about all replication groups in this zone          |
-----------------------------------+-----------+---------------------------------------------------------------------+--------  
url.rglinksFailed                  |           |   URL to get data about failed replication (RG) connections         |
                                   |           |      to remote zones from this zone                                 |
-----------------------------------+-----------+---------------------------------------------------------------------+--------  
url.rglinksBootstrap               |           |   URL to get data about replication (RG) connections to             |
                                   |           |      remote zones being added to the replication groups visible     |
                                   |           |      from this zone                                                 |
-----------------------------------+-----------+---------------------------------------------------------------------+--------  
name                               |           |   Name of the zone                                                  |
-----------------------------------+-----------+---------------------------------------------------------------------+--------  
numNodes                           |           |   Number of nodes in the zone                                       |
-----------------------------------+-----------+---------------------------------------------------------------------+--------  
nodeCpuUtilizationAvg              |Historical |   Average CPU utilization across nodes in this zone                 |Percent 
-----------------------------------+-----------+---------------------------------------------------------------------+--------  
nodeMemoryUtilizationBytesAvg      |Historical |   Average RAM utilization across nodes in this zone                 |Bytes 
-----------------------------------+-----------+---------------------------------------------------------------------+--------  
nodeMemoryUtilizationAvg           |Historical |   Average RAM utilization percentage relatively to total node       |Percent
                                   |           |      memory size across nodes in this zone                          |    
-----------------------------------+-----------+---------------------------------------------------------------------+--------  
nodeNicBandwidthAvg                |Historical |   Average NIC utilization across nodes in this zone                 |MB/s 
-----------------------------------+-----------+---------------------------------------------------------------------+--------  
nodeNicUtilizationAvg              |Historical |   Average NIC utilization percentage relatively to node MAX         |
                                   |           |      capacity across nodes in this zone Percent                     | 
-----------------------------------+-----------+---------------------------------------------------------------------+--------  
transactionReadLatency             |Historical |   Average latency for external read transactions                    |ms 
-----------------------------------+-----------+---------------------------------------------------------------------+--------  
transactionWriteLatency            |Historical |   Average latency for external write transactions                   |ms 
-----------------------------------+-----------+---------------------------------------------------------------------+--------  
transactionReadBandwidth           |Historical |   Average amount of data returned by external read transactions     |MB/s
                                   |           |      per second                                                     |    
-----------------------------------+-----------+---------------------------------------------------------------------+--------  
transactionWriteBandwidth          |Historical |   Average amount of data written by external write transactions     |MB/s 
                                   |           |      per second                                                     |  
-----------------------------------+-----------+---------------------------------------------------------------------+--------  
transactionReadTransactionsPerSec  |Historical |   Average number of external Read transactions per second           |TPS 
-----------------------------------+-----------+---------------------------------------------------------------------+--------  
transactionWriteTransactionsPerSec |Historical |   Average number of external Write transactions per second          |TPS 
-----------------------------------+-----------+---------------------------------------------------------------------+--------  
transactionErrors.all              |Historical |   Percentage of failed transactions per second over the             |Percent 
                                   |           |      previous interval                                              |   
-----------------------------------+-----------+---------------------------------------------------------------------+--------  
transactionErrors.types.errorType  |           |   Type of Error, e.g. <add examples>                                |
-----------------------------------+-----------+---------------------------------------------------------------------+--------  
transactionErrors.types.errorRate  |Historical |   Percentage of failed transactions with this error Type per        |Percent 
                                   |           |      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. 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     |MB/s 
                                   |           |      second                                                         | 
-----------------------------------+-----------+---------------------------------------------------------------------+--------  
diskWriteBandwidthEc               |Historical |   Average amount of data written to disks for Erasure Coding per    |MB/s 
                                   |           |      second                                                         |  
-----------------------------------+-----------+---------------------------------------------------------------------+--------  
diskReadBandwidthCc                |Historical |   Average amount of data read from disks for Consistency Check per  |MB/s 
                                   |           |      second                                                         |
-----------------------------------+-----------+---------------------------------------------------------------------+--------  
diskWriteBandwidthCc               |Historical |   Average amount of data written to disks for Consistency Check per |MB/s 
                                   |           |      second                                                         |  
-----------------------------------+-----------+---------------------------------------------------------------------+--------  
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    |MB/s 
                                   |           |      second                                                         |
-----------------------------------+-----------+---------------------------------------------------------------------+--------  
diskWriteBandwidthGeo              |Historical |   Average amount of data written to disks for Geo Replication per   |MB/s 
                                   |           |      second                                                         |  
-----------------------------------+-----------+---------------------------------------------------------------------+--------  
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     |MB/s 
                                   |           |      second                                                         |
-----------------------------------+-----------+---------------------------------------------------------------------+--------  
diskWriteBandwidthXor              |Historical |   Average amount of data written to disks for XOR operations per    |MB/s 
                                   |           |      second                                                         |
-----------------------------------+-----------+---------------------------------------------------------------------+--------  
replicationRpoTimestamp            |           |   Recovery Point Objective for the zone - Time stamp of the oldest  |seconds 
                                   |           |      data that can be lost in case of this zone failure.            | 
-----------------------------------+-----------+---------------------------------------------------------------------+--------
Notes: