Search (SHIFT+S)
ECS Management API
ECS Object Service API
-
Amazon S3
- S3 Bucket
- S3 Bucket ACL
- S3 Bucket Cors
- S3 Bucket Is Stale Allowed
- S3 Bucket Lifecycle
- S3 Bucket List Uploads
- S3 Bucket Location
- S3 Bucket Policy
- S3 Bucket Versioning
- S3 Bucket Versions
- S3 Data Node
- S3 Metadata Key List
- S3 Metadata Key System List
- S3 Metadata Search
- S3 Multi Object Delete
- S3 Object
- S3 Object ACL
- S3 Object Init Uploads
- S3 Object Replication Info Operations
- S3 Object Tagging Operations
- S3 Object Uploads
- S3 Options
- S3 Ping
- S3 Retention Update Operation
- EMC Atmos
- OpenStack Swift
ECS API Changes
Get Node
GET /dashboard/nodes/{id}
Gets the node instance details.
| id | Node identifier |
Required Roles
Requires one of the following roles:
SYSTEM_MONITOR
SYSTEM_ADMIN
Response Body
Node instance details.
JSON Example
Request
GET https://192.168.0.0:4443/dashboard/nodes/node-id 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/nodes/{node-id}" },
"disks": { "href": "/dashboard/nodes/{node-id}/disks" },
"processes": { "href": "/dashboard/nodes/{node-id}/processes" }
},
"apiChange" : "1",
"id": {node-id},
"displayName": {display-name},
"healthStatus": "Good",
"numDisks": "40",
"numGoodDisks": "40",
"numBadDisks": "0",
"numMaintenanceDisks": "0",
"numReadyToReplaceDisks": "0",
"storagePoolId" : "8c857c49-b77e-4af8-ae76-5adb0c5b62ef",
"storagePoolName" : "CommodityvPool",
"allocatedCapacityForecast" : [
{"unit" : "day", "forecast" : "9", "history" : "7", "target" : "50"},
{"unit" : "day", "forecast" : "15", "history" : "7", "target" : "80"},
{"unit" : "", "forecast" : "N/A", "history" : "30", "target" : "50"},
{"unit" : "day", "forecast" : "53", "history" : "30", "target" : "80"}
],
"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}],
"diskSpaceAllocatedL1" : [ { "t" : "1502322826", "Space" : "44217988320" } ],
"diskSpaceAllocatedL2" : [ { "t" : "1502322582", "Space" : "59861049600" } ]
"diskSpaceAllocatedPercentage" : [ { "t" : "1502322582", "Percent" : "1.3010893632101532" } ],
"diskSpaceFreeL1" : [ { "t" : "1502322826", "Space" : "7547002489760" } ],
"diskSpaceFreeL2" : [ { "t" : "1502322582", "Space" : "348295061120" } ],
"diskSpaceOfflineTotalCurrent" : [ { "t" : "1502937134", "Space" : "0" } ],
"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"}],
"nodeNicReceivedBandwidth": [ {"t":"12345678" , " Bandwidth":1000}, {"t":"23435455" , " Bandwidth":4300}, {"t":"55433455" , " Bandwidth":"3009"}],
"nodeNicTransmittedBandwidth": [ {"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"}],
"nodeNicReceivedUtilization": [ {"t":"12345678" , "Percent":10}, {"t":"23435455" , "Percent":43}, {"t":"55433455" , "Percent":"39"}],
"nodeNicTransmittedUtilization": [ {"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}],
"errorSuccessTotals" : [ {"successTotal" : 181449, "errorTotal" : 16512} ],
"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}]
}, {
"errorType" : "404 (S3)",
"category" : "User",
"errorCount" : "5059",
"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)
c. <Attribute>Current: The most recent value of an attribute. The attribute is returned in the form of a single snapshot
{"t":12345678, " 'value tag' ":10} where 'value tag' 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 corresponding historical attribute.
d. <Attribute>Summary: (historical attributes only) The summary values for a historical attribute which includes
Min (lowest), Max (highest) and Avg (average) values across all snapshots. The attribute is returned in the form 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 corresponding historical attribute.
e. 'dataType' filter: The client can use this filter to indicate which data needs to be returned in the feed. If not supplied,
both current and historical data will be returned.
dataType=current: return only the Current values, as detailed in Point C.
dataType=historical&startTime=<Time>&endTime=<Time>&interval=<Interval in seconds>: return historical series data
and summary for the period specified. Start and End Times are in Epoch Time in Seconds.
f. '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.
category=capacityForecast: Use this filter to fetch specifically capacity forecasts for specified time frames and
capacity targets. This filter works in conjunction with the following query parameters:
cfTimeFrame: The list of time frames in the form of {<integer>d;<integer>w;...}, e.g., {7d;30d;26w}, with 'd' for day
and 'w' for week. For example, '7d' means the forecast is based on used capacity data in last 7 days.
cfTarget: The list of targeted percentage of total capacity in the form of {<integer>;<integer>;...}, e.g., {50;80}.
The forecast is based on linear regression of the historical data in the specified time frames. The results are
number of days from now for used capacity to reach targeted capacity or 0 when used capacity has reached a specified
target or "N/A" when
a) used capacity history shows a downward trend in any specified time frames, or
b) there are less than two historical data points in any specified time frames.
curl example: curl -ksv https://10.1.1.1:4443/dashboard/nodes/{id}?category=capacityForecast\&cfTimeFrame='\{7d;40d\}'\&cfTarget='\{60;99\}'
g. Starting from ECS 2.2 a new attribute named "apiChange' is returned. This variable may be removed in future versions
of the API, and currently always has the value "1".
------------------------------------+-----------+-----------------------------------------------------------------------+--------
Attribute | dataType |Category| Description |Units
------------------------------------+-----------+-----------------------------------------------------------------------+--------
url.self | | | URL to this 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 |
------------------------------------+-----------+-----------------------------------------------------------------------+--------
numGoodDisks | |health | Number of disks with a Good status in the DAE associated |
| | | with the node |
------------------------------------+-----------+-----------------------------------------------------------------------+--------
numBadDisks | |health | Number of disks with a Bad status in the DAE associated |
| | | with the node |
------------------------------------+-----------+-----------------------------------------------------------------------+--------
numMaintenanceDisks | |health | Number of disks on Node with status of Maintenance |
------------------------------------+-----------+-----------------------------------------------------------------------+--------
numReadyToReplaceDisks | |health | Number of disks on Node with status of Ready to replace |
------------------------------------+---+-------+-----------------------------------------------------------------------+--------
allocatedCapacityForecast | |capacityForecast| Capacity forecast for given time frames and targets |
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskSpaceTotal |historical |capacity| Total usable disk space across all disks in the DAE |
| | associated with the node |
| | | with the node | Bytes
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskSpaceFree |historical |capacity| Total free usable disk space across all disks in the DAE |
| | | associate with the node | Bytes
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskSpaceAllocated |historical |capacity| Total disk space allocated for chunks across all disks E |
| | | in the DAE associated with the node | Bytes
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskSpaceAllocatedL1 |historical |capacity| Space allocated for chunks on the disk(s) for L1 | Bytes
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskSpaceAllocatedL2 |historical |capacity| Space allocated for chunks on the disk(s) for L2 | Bytes
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskSpaceAllocatedPercentage |historical |capacity| Total allocated space over total usable space on disk(s) | Bytes
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskSpaceOfflineTotalCurrent | |capacity| Total current offline disk space for this node | Bytes
| | | including only capacity of Offline nodes and |
| | | disks (with status NotAccessible, Suspect, Bad, Maintenance).|
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskSpaceFree |historical |capacity| Total free usable disk space of disk(s) if status is Good | Bytes
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskSpaceFreeL1 |historical |capacity| Level 1 usable disk space | Bytes
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskSpaceFreeL2 |historical |capacity| Level 2 usable disk space | Bytes
------------------------------------+-----------+-----------------------------------------------------------------------+--------
healthStatus | | | Status of the node - Good, Suspect, Bad, NotAccessible, |
| | | Maintenance |
------------------------------------+-----------+-----------------------------------------------------------------------+--------
nodeCpuUtilization | |health | 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 | |health |Amount of RAM used on the node excluding buffered and cached |
| | |space. | Bytes
------------------------------------+-----------+-----------------------------------------------------------------------+--------
nodeMemoryUtilization | |health |Amount of RAM used on the node relativeley to the total RAM |
| | |size. | Percent
------------------------------------+-----------+-----------------------------------------------------------------------+--------
nodeNicBandwidth | |health |Amount of data transferred through NIC cards on this node per |
| | |second. | MB/s
------------------------------------+-----------+-----------------------------------------------------------------------+--------
nodeNicReceivedBandwidth | |health |Amount of data received through NIC cards on this node per |
| | |second. | MB/s
------------------------------------+-----------+-----------------------------------------------------------------------+--------
nodeNicTransmittedBandwidth | |health |Amount of data transmitted through NIC cards on this node per |
| | |second. | MB/s
------------------------------------+-----------+-----------------------------------------------------------------------+--------
nodeNicUtilization | |health |Amount of data transferred through NIC cards on this node per |
| | |second relative to maximum capacity. | Percent
------------------------------------+-----------+-----------------------------------------------------------------------+--------
nodeNicReceivedUtilization | |health | Amount of data received through NIC cards on this node per |
| | | second relative to maximum capacity. | Percent
------------------------------------+-----------+-----------------------------------------------------------------------+--------
nodeNicTransmittedUtilization | |health |Amount of data transmitted through NIC cards on this node per |
| | |second relative to maximum capacity. | Percent
------------------------------------+-----------+-----------------------------------------------------------------------+--------
transactionReadLatency |historical |traffic |Average amount of time taken to process read transactions. | Milliseconds
------------------------------------+-----------+-----------------------------------------------------------------------+--------
transactionWriteLatency |historical |traffic |Average amount of time taken to process write transactions. | Milliseconds
------------------------------------+-----------+-----------------------------------------------------------------------+--------
transactionReadBandwidth |historical |traffic |Average amount of data returned in read transactions per |
| | |second over the previous interval | MB/s
------------------------------------+-----------+-----------------------------------------------------------------------+--------
transactionWriteBandwidth |historical |traffic |Average amount of data received in write transactions per |
| | |second over the previous interval | MB/s
------------------------------------+-----------+-----------------------------------------------------------------------+--------
transactionReadTransactionsPerSec |historical |traffic |Average number of read transactions requested per second over |
| | |the previous interval | TPS
------------------------------------+-----------+-----------------------------------------------------------------------+--------
transactionWriteTransactionsPerSec |historical |traffic |Average number of write transactions requested per second over|
| |traffic |the previous interval | TPS
------------------------------------+-----------+-----------------------------------------------------------------------+--------
transactionErrors.all |historical |traffic |Average number of failed transac tions per second over the |
| |traffic |previous interval | Percent
------------------------------------+-----------+-----------------------------------------------------------------------+--------
transactionErrors.errorSuccessTotals|historical |traffic |Total number of successful transactions |
.successTotal | | | |
------------------------------------+-----------+-----------------------------------------------------------------------+--------
transactionErrors.errorSuccessTotals|historical |traffic |Total number of error transactions |
.errorTotal | | | |
------------------------------------+-----------+-----------------------------------------------------------------------+--------
transactionErrors.types.errorType |historical |traffic |Type of Error, e.g., "404 (S3)" |
------------------------------------+-----------+-----------------------------------------------------------------------+--------
transactionErrors.types.category |historical |traffic |Type of Error category, e.g., User, System |
------------------------------------+-----------+-----------------------------------------------------------------------+--------
transactionErrors.types.errorCount |historical |traffic |Total error count in the error type and category |
------------------------------------+-----------+-----------------------------------------------------------------------+--------
transactionErrors.types.errorRate |historical |traffic |Average number 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. 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. | Percent
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskReadBandwidthTotal |historical |diskIO |Average amount of data read from disks per second | MB/s
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskWriteBandwidthTotal |historical |diskIO |Average amount of data written to disks per second | MB/s
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskReadBandwidthEc |historical |diskIO |Average amount of data read from disks for Erasure Coding per |
| | | | MB/s
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskWriteBandwidthEc |historical |diskIO |Average amount of data written to disks for Erasure Coding |
| | |per second | MB/s
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskReadBandwidthCc |historical |diskIO |Average amount of data read from disks for Consistency |
| | |Checkper second | MB/s
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskWriteBandwidthCc |historical |diskIO |Average amount of data written to disks for Consistency Check |
| | |per second | MB/s
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskReadBandwidthRecovery |historical |diskIO |Average amount of data read from disks for Recovery per | MB/s
| | |second |
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskWriteBandwidthRecovery |historical |diskIO |Average amount of data written to disks for Recovery per | MB/s
| | |second |
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskReadBandwidthGeo |historical |diskIO |Average amount of data read from disks for Geo Replication |
| | |per second | MB/s
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskWriteBandwidthGeo |historical |diskIO |Average amount of data written to disks for Geo Replication |
| | |per second | MB/s
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskReadBandwidthUser |historical |diskIO |Average amount of data read from disks for User data per |
| | |second | MB/s
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskWriteBandwidthUser |historical |diskIO |Average amount of data written to disks for User Data per | MB/s
| | |second |
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskReadBandwidthXor |historical |diskIO |Average amount of data read from disks for XOR operations per |
| | |second | MB/s
------------------------------------+-----------+-----------------------------------------------------------------------+--------
diskWriteBandwidthXor |historical |diskIO |Average amount of data written to disks for XOR operations per|
| | |second | MB/s
------------------------------------+-----------+-----------------------------------------------------------------------+--------
storagePoolId | | |ID of the StoragePool |
------------------------------------+-----------+-----------------------------------------------------------------------+--------
storagePoolName | | |Name of the StoragePool |
------------------------------------+-----------+-----------------------------------------------------------------------+--------