Search (SHIFT+S)
ECS Management API
ECS Object Service API
-
Amazon S3
- S3 Bucket
- S3 Bucket ACL
- S3 Bucket Cors
- S3 Bucket Empty Status Operations
- S3 Bucket Is Stale Allowed
- S3 Bucket Lifecycle
- S3 Bucket List Fanout (Cloud DVR)
- S3 Bucket List Uploads
- S3 Bucket Location
- S3 Bucket Lock Configuration Operations
- S3 Bucket Object Lock Operations
- 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 Detailed Replication Status Operations
- S3 Object Init Uploads
- S3 Object Legal Hold Operations
- S3 Object Replication Info Operations
- S3 Object Retention Operations
- S3 Object Tagging Operations
- S3 Object Uploads
- S3 Options
- S3 Ping
- S3 Retention Update Operation
- S3 Select Operations
- EMC Atmos
- OpenStack Swift
ECS API Changes
Get Local Zone
GET /dashboard/zones/localzone
Gets the local VDC details.
Required Roles
Requires one of the following roles:
SYSTEM_MONITOR
SYSTEM_ADMIN
Response Body
Local VDC details
Examples
Request
GET https://192.168.0.0:4443/dashboard/zones/localzone 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" }
},
"apiChange" : "1",
"name": "vdc1",
"id" : "localzone",
"numNodes": "4",
"numGoodNodes": "4",
"numBadNodes": "0",
"numMaintenanceNodes": "0",
"numDisks": "32",
"numGoodDisks": "32",
"numBadDisks": "0",
"numMaintenanceDisks": "0",
"numReadyToReplaceDisks ": "0",
"alertsNumUnackCritical" : [ { "t" : "1502827401", "Count" : "1" } ],
"alertsNumUnackError" : [ { "t" : "1502827401", "Count" : "0" } ],
"alertsNumUnackInfo" : [ { "t" : "1502827401", "Count" : "3" } ],
"alertsNumUnackWarning" : [ { "t" : "1502827401", "Count" : "2" } ],
"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"}
],
"chunksRepoNumber": "10",
"chunksRepoTotalSealSize": "5000000",
"chunksRepoAvgSealSize": "2500000",
"chunksL0BtreeNumber": "1000",
"chunksL0BtreeTotalSize": "5000000",
"chunksL0BtreeAvgSize": "5000000",
"chunksL0JournalNumber": "1000",
"chunksL0JournalTotalSize": "5000000",
"chunksL0JournalAvgSize": "2500000",
"chunksL1BtreeNumber": "1000",
"chunksL1BtreeTotalSize": "5000000",
"chunksL1BtreeAvgSize": "5000000",
"chunksL1JournalNumber": "4500",
"chunksL1JournalTotalSize": "5000000",
"chunksL1JournalAvgSize": "2500000",
"chunksGeoCopyNumber": "3000",
"chunksGeoCopyTotalSize": "3500000",
"chunksGeoCopyAvgSize": "1500000",
"chunksXorNumber": "2500",
"chunksXorTotalSize": "2750000",
"chunksXorAvgSize": "1500000",
"chunksEcCodedTotalSealSizeCurrent": "3500000",
"chunksEcApplicableTotalSealSizeCurrent": "3500000",
"chunksEcCodedRatioCurrent": "90",
"chunksEcRateCurrent": "250",
"chunksRepoPendingReplicationTotalSize": "1750000",
"chunksJournalPendingReplicationTotalSize": "1250000",
"replicationIngressTrafficCurrent": "50000",
"replicationEgressTrafficCurrent": "35000",
"FailoverProgressPercent": "75",
"BootstrapProgressPercent": "65",
"capacityRebalanceEnabled" : "true",
"capacityPendingRebalancing" : "0",
"capacityRebalanced" : "1990894400",
"capacityRebalanceRate" : [ { "t" : "1512590400", "Bytes" : "0" }, { "t" : "1512594000", "Bytes" : "0" }],
"capacityPendingRebalancingAvg" : [ { "t" : "1512586800", "Bytes" : "0" }, { "t" : "1512590400", "Bytes" : "0" }] ,
"capacityRebalancedAvg" : [ { "t" : "1512586800", "Bytes" : "1990894400" }, { "t" : "1512590400", "Bytes" : "1990894400" }],
"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"}],
"nodeNicReceivedBandwidthAvg": [ {"t":"12345678" , " Bandwidth":1000}, {"t":"23435455" , " Bandwidth":4300}, {"t":"55433455" , " Bandwidth":"3009"}],
"nodeNicTransmittedBandwidthAvg": [ {"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"}],
"nodeNicReceivedUtilizationAvg": [ {"t":"12345678" , " Percent ":10}, {"t":"23435455" , " Percent ":43}, {"t":"55433455" , " Percent ":"39"}],
"nodeNicTransmittedUtilizationAvg": [ {"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" : 2020,
"errorTotal" : 6298
} ],
"types" : [ {
"errorType" : "404 (S3)",
"category" : "User",
"errorCount" : "6293",
"errorRate": [ {"t" : "1463004000","Rate" : "75.7506330640299"}, {"t" : "1463151600","Rate" : "50.0"}, {"t":"55433455" , " Rate ":2}]
}, {
"errorType" : "400 (S3)",
"category" : "User",
"errorCount" : "4",
"errorRate": [ {"t":"12345678" , " Rate ":10}, {"t":"23435455" , " Rate ":0}, {"t":"55433455" , " Rate ":2}]
}, {
"errorType" : "412 (ATMOS)",
"category" : "User",
"errorCount" : "1",
"errorRate": [ {"t":"12345678" , " Rate ":10}, {"t":"23435455" , " Rate ":0}, {"t":"55433455" , " Rate ":2}]
} ]
},
"diskSpaceTotalCurrent": [ {"t":"12345678" , "Bytes ":10000}, {"t":"23456789", "Bytes ":12000} ],
"diskSpaceFreeCurrent": [ {"t":"12345678" , "Bytes ":10000}, {"t":"23456789", "Bytes ":12000} ],
"diskSpaceAllocatedCurrent": [ {"t":"12345678", "Bytes ":10000}, {"t":"23456789", "Bytes ":12000} ],
"diskSpaceAllocatedGeoCacheCurrent" : [ { "t" : "1502902238432", "Capacity" : "0" } ],
"diskSpaceAllocatedGeoCopyCurrent" : [ { "t" : "1502902238432", "Capacity" : "536870400" } ],
"diskSpaceAllocatedLocalProtectionCurrent" : [ { "t" : "1502902238432", "Capacity" : "75743465600" } ],
"diskSpaceAllocatedSystemMetadataCurrent" : [ { "t" : "1502902238432", "Capacity" : "37312492800" } ],
"diskSpaceAllocatedUserDataCurrent" : [ { "t" : "1502902238432", "Capacity" : "134217600" } ],
"diskSpaceOfflineTotalCurrent" : [ { "t" : "1502901090", "Space" : "0" } ],
"diskSpaceReservedCurrent" : [ { "t" : "1512778311", "Space" : "207500681984" } ],
"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",
"replicationRpoLag": "7200",
"recoveryBadChunksTotalSizeCurrent" : [ { "t" : "1501528064", "Space" : "0" } ],
"recoveryRateCurrent" : [ { "t" : "1502902238", "Rate" : "0" } ],
"gcUserDataIsEnabled" : "true",
"gcSystemMetadataIsEnabled" : "true",
"gcUserTotalDetectedCurrent" : [ { "t" : "1512758218", "Capacity" : "2952787200" } ],
"gcUserPendingCurrent" : [ { "t" : "1512758218", "Capacity" : "0" } ],
"gcUserReclaimedCurrent" : [ { "t" : "1512758218", "Capacity" : "2952787200" } ],
"gcUserUnreclaimableCurrent" : [ { "t" : "1512758218", "Capacity" : "0" } ],
"gcSystemTotalDetectedCurrent" : [ { "t" : "1512758218", "Capacity" : "805305600" } ],
"gcSystemPendingCurrent" : [ { "t" : "1512758218", "Capacity" : "0" } ],
"gcSystemReclaimedCurrent" : [ { "t" : "1512758218", "Capacity" : "805305600" } ],
"gcSystemUnreclaimableCurrent" : [ { "t" : "1512758218", "Capacity" : "0" } ],
"gcCombinedTotalDetectedCurrent" : [ { "t" : "1512758218", "Capacity" : "3758092800" } ],
"gcCombinedPendingCurrent" : [ { "t" : "1512758218", "Capacity" : "0" } ],
"gcCombinedReclaimedCurrent" : [ { "t" : "1512758218", "Capacity" : "3758092800" } ],
"gcCombinedUnreclaimableCurrent" : [ { "t" : "1512758218", "Capacity" : "0" } ],
"gcUserReclaimedOverTimeRange" : [ { "t" : "1512759186", "Capacity" : "0" } ],
"gcSystemReclaimedOverTimeRange" : [ { "t" : "1512759186", "Capacity" : "0" } ],
"gcCombinedReclaimedOverTimeRange" : [ { "t" : "1512759186", "Capacity" : "0" } ],
"gcUserReclaimedPerInterval" : [ {
"t" : "1512345600",
"Capacity" : "2952787200"
}, {
"t" : "1512756000",
"Capacity" : "0"
} ],
"gcSystemReclaimedPerInterval" : [ {
"t" : "1512734400",
"Capacity" : "805305600"
}, {
"t" : "1512756000",
"Capacity" : "0"
} ],
}
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/zones/localzone?category=capacityForecast\&cfTimeFrame='\{7d;40d\}'\&cfTarget='\{60;99\}'
g. Starting from ECS 2.2 a new attribute named "apiChange' is returned. This attribute 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.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 |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
id | | |ID of the zone (localzone) |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
name | | |Name of the zone |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
numNodes | | |Number of nodes in the zone |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
numGoodNodes | |health |Number of nodes in the zone with Good state |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
numBadNodes | |health |Number of nodes in the zone with Bad state |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
numMaintenanceNodes | |health |Number of nodes in the zone with Maintenance state |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
numDisks | | |Number of disks in the zone |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
numGoodDisks | |health |Number of disks in the zone with Good state |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
numBadDisks | |health |Number of disks in the zone with Bad state |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
numMaintenanceDisks | |health |Number of disks in the zone with Maintenance state |
-----------------------------------+-----------+-----------------------------------------------------------------------------+--------
numReadyToReplaceDisks | |health | Number of disks on Node with status of Ready to replace |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
alertsNumUnackCritical | |alerts |Number of Unacknowledged Critical alerts |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
alertsNumUnackError | |alerts |Number of Unacknowledged Error alerts |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
alertsNumUnackInfo | |alerts |Number of Unacknowledged Info alerts |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
alertsNumUnackWarning | |alerts |Number of Unacknowledged Warning alerts |
-----------------------------------+---+-------+--------+--------------------------------------------------------------------+--------
allocatedCapacityForecast | |capacityForecast|Capacity forecast for given time frames and targets |
-----------------------------------+---+-------+--------+--------------------------------------------------------------------+--------
nodeCpuUtilizationAvg |historical |health |Average CPU utilization across nodes in this zone |Percent
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
nodeMemoryUtilizationBytesAvg |historical |health |Average RAM utilization across nodes in this zone |Bytes
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
nodeMemoryUtilizationAvg |historical |health |Average RAM utilization percentage relatively to total node |Percent
| | |memory size across nodes in this zone |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
nodeNicBandwidthAvg |historical |health |Average NIC utilization across nodes in this zone |MB/s
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
nodeNicReceivedBandwidthAvg |historical |health |Average NIC received utilization across nodes in this zone |MB/s
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
nodeNicTransmittedBandwidthAvg |historical |health |Average NIC transmitted utilization across nodes in this zon e |MB/s
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
nodeNicUtilizationAvg |historical |health |Average NIC utilization percentage relatively to node MAX |Percent
| | |capacity across nodes in this zone Percent |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
nodeNicReceivedUtilizationAvg |historical |health |Average NIC received utilization percentage relative to node |Percent
| | |MAX capacity across nodes in this zone Percent |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
nodeNicTransmittedUtilizationAvg |historical |health |Average NIC transmitted utilization percentage relative to |Percent
| | |node MAX capacity across nodes in this zone Percent |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
capacityRebalanceEnabled | |health |Flag indicating if node data rebalancing is enabled for this zone |Boolean
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
capacityRebalanced | |health |Amount of data that has been rebalanced across nodes in this zone |Bytes
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
capacityPendingRebalancing | |health |Amount of data that is pending rebalancing across nodes in zone |Bytes
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
capacityRebalancedAvg |historical |health |Average amount of data rebalanced as of historical timestamp |Bytes
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
capacityRebalanceRate |historical |health |Rate of rebalance as of historical timestamp |Bytes
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
capacityPendingRebalancingAvg |historical |health |Average amount of data to be rebalanced as of historical timestamp |Bytes
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
transactionReadLatency |historical |traffic |Average latency for external read transactions |ms
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
transactionWriteLatency |historical |traffic |Average latency for external write transactions |ms
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
transactionReadBandwidth |historical |traffic |Average amount of data returned by external read transactions |MB/s
| | |per second |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
transactionWriteBandwidth |historical |traffic |Average amount of data written by external write transactions |MB/s
| | |per second |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
transactionReadTransactionsPerSec |historical |traffic |Average number of external Read transactions per second |TPS
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
transactionWriteTransactionsPerSec |historical |traffic |Average number of external Write transactions per second |TPS
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
transactionErrors.all |historical |traffic |Percentage of failed transactions per second over the |Percent
| | |previous interval |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
transactionErrors. |historical |traffic |Count of successful requests over the sample period |
errorSuccessTotals. | | | |
successTotal | | | |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
transactionErrors. |historical |traffic |Count of failed requests over the sample period. |
errorSuccessTotals. | | | |
errorTotal | | | |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
transactionErrors.types.errorType |historical |traffic |Error Type e.g. 412 (S3), 401 (ATMOS) |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
transactionErrors.types.category |historical |traffic |Error Category - User or System |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
transactionErrors.types.errorCount |historical |traffic |Count of failed requests |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
transactionErrors.types.errorRate |historical |traffic |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 |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
| | |second |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
diskWriteBandwidthEc |historical | diskIO |Average amount of data written to disks for Erasure Coding per |MB/s
| | |second |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
diskReadBandwidthCc |historical | diskIO |Average amount of data read from disks for Consistency Check |MB/s
| | |per second |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
diskWriteBandwidthCc |historical | diskIO |Average amount of data written to disks for Consistency Check |MB/s
| | |per second |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
diskReadBandwidthRecovery |historical | diskIO |Average amount of data read from disks for Recovery per second |MB/s
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
diskWriteBandwidthRecovery |historical | diskIO |Average amount of data written to disks for Recovery per second |MB/s
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
diskReadBandwidthGeo |historical | diskIO |Average amount of data read from disks for Geo Replication per |MB/s
| | |second |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
diskWriteBandwidthGeo |historical | diskIO |Average amount of data written to disks for Geo Replication per |MB/s
| | |second |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
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 second |MB/s
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
diskReadBandwidthXor |historical | diskIO |Average amount of data read from disks for XOR operations per |MB/s
| | |second |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
diskWriteBandwidthXor |historical | diskIO |Average amount of data written to disks for XOR operations per |MB/s
| | |second |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
diskSpaceTotalCurrent | |capacity|Total current disk space across all nodes in the storage pool |Bytes
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
diskSpaceFreeCurrent | |capacity|Total current free disk space across all nodes in the storage |Bytes
| | |pool |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
diskSpaceAllocatedCurrent | |capacity|Total current allocated disk space across all nodes in the |Bytes
| | |storage pool |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
diskSpaceAllocatedGeoCacheCurrent | |capacity|Disk space allocated for cached chunks |Bytes
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
diskSpaceAllocatedGeoCopyCurrent | |capacity|Disk space allocated for chunk copies |Bytes
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
diskSpaceAllocatedLocalProtectionCurrent |capacity|Disk space allocated for local protection |Bytes
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
diskSpaceAllocatedSystemMetadataCurrent |capacity|Disk space allocated for system metadata |Bytes
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
diskSpaceAllocatedUserDataCurrent | |capacity|Disk space allocated for user data |Bytes
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
diskSpaceOfflineTotalCurrent | |capacity|Total current offline disk space across all storage pools |Bytes
| | |in this zone, including only capacity of Offline nodes and |
| | |disks (with status NotAccessible, Suspect, Bad). |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
diskSpaceReservedCurrent | |capacity|Disk space reserved for local zone |Bytes
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
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
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
chunksEcCodedTotalSealSizeCurrent | | chunks |Current total seal size of Erasure Coded chunks in the |Bytes
| | |storage pool |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
chunksEcApplicableTotalSealSize | | chunks |Current total seal size of chunks in the storage pool that |Bytes
| | |are applicable/subject to Erasure Coding (Repo+GeoCopy+XOR) |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
chunksEcCodedRatioCurrent | | chunks |Ratio of total space of Erasure Coded chunks to total |
| | |space of all |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
chunksEcRateCurrent | | chunks |Average amount of data being erasure coded per second over |
| | |the previous interval |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
chunksRepoPendingReplicationTotal | | geo |Total size of the repo chunks which are pending replication |bytes
Size | | | |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
chunksJournalPendingReplication | | geo |Total size of the journal chunks which are pending |bytes
TotalSize | | |replication |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
replicationRpoTimestamp | | geo |Recovery Point Objective for the zone - Time stamp of the |seconds
| | |oldest data that can be lost in case of this zone failure. |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
replicationRpoLag | | geo |Recovery Point Objective Lag for the zone - Time lag of the |seconds
| | |oldest data that can be lost in case of this zone failure. |
| | |More reliable than "replicationRpoTimestamp" |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
replicationIngressTrafficCurrent | | geo |Amount of traffic flowing into the system. Writes into the |
| | |system |bytes/s
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
replicationEgressTrafficCurrent | | geo |Amount of traffic flowing out from the system. Reads from |
| | |the system |bytes/s
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
FailoverProgressPercentage | | geo |Progress of the Failover operations |percent
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
BootstrapProgressPercent | | geo |Progress of the Bootstrap operations |percent
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
recoveryBadChunksTotalSize | | chunks |Total size of the bad chunks to be recovered. |bytes
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
recoveryRateCurrent | | chunks |Current rate of bad chunk recovery |bytes/s
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
gcUserDataIsEnabled | |capacity|Flag indicating if garbage collection is enabled for User Data |boolean
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
gcSystemMetadataIsEnabled | |capacity|Flag indicating if garbage collection is enabled for System Metadata|boolean
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
gcUserTotalDetectedCurrent | |capacity|User data garbage detected |bytes
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
gcUserPendingCurrent | |capacity|User data garbage pending reclamation |bytes
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
gcUserReclaimedCurrent | |capacity|User data garbage reclaimed |bytes
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
gcUserUnreclaimableCurrent | |capacity|User data garbage detected but not yet reclaimable |bytes
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
gcSystemTotalDetectedCurrent | |capacity|System metadata garbage detected |bytes
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
gcSystemPendingCurrent | |capacity|System metadata garbage pending reclamation |bytes
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
gcSystemReclaimedCurrent | |capacity|System metadata garbage reclaimed |bytes
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
gcSystemUnreclaimableCurrent | |capacity|System metadata garbage detected but not yet reclaimable |bytes
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
gcCombinedTotalDetectedCurrent | |capacity|Combined User and System data garbage detected |bytes
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
gcCombinedPendingCurrent | |capacity|Combined User and System data garbage pending reclamation |bytes
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
gcCombinedReclaimedCurrent | |capacity|Combined User and System data garbage reclaimed |bytes
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
gcCombinedUnreclaimableCurrent | |capacity|Combined User and System data garbage pending reclamation |bytes
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
gcUserReclaimedOverTimeRange |historical |capacity|Returns one item - the delta between first and last item in history |bytes
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
gcSystemReclaimedOverTimeRange |historical |capacity|Returns one item - the delta between first and last item in history |bytes
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
gcCombinedReclaimedOverTimeRange |historical |capacity|Sum of User and System reclaimed over time range |bytes
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
gcUserReclaimedPerInterval |historical |capacity|Returns a time series list and each value is the amount of data |bytes
| | |added over the interval period. Any negative values are returned |
| | |as zeros. |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------
gcSystemReclaimedPerInterval |historical |capacity|Returns a time series list and each value is the amount of data |bytes
| | |added over the interval period. Any negative values are returned |
| | |as zeros. |
-----------------------------------+-----------+--------+--------------------------------------------------------------------+--------