The volumeStats object contains statistical data for an individual volume.
This object contains the following members:
| Name | Description | Calculation | Type |
|---|---|---|---|
| accountID | The ID of the account of the volume owner. | N/A | integer |
| actualIOPS | The current actual IOPS to the volume in the last 500 milliseconds. | Point in time | integer |
| asyncDelay | The length of time since the volume was last synced with the remote cluster. If the volume is not paired, this is null. Note: A target volume in an active replication state always has an asyncDelay of 0 (zero). Target volumes are system-aware during replication and assume asyncDelay is accurate at all times.
|
N/A | ISO 8601 duration string or null |
| averageIOPSize | The average size in bytes of recent I/O to the volume in the last 500 milliseconds. | Point in time | integer |
| burstIOPSCredit | The total number of IOP credits available to the user. When volumes are not using up to the configured maxIOPS, credits are accrued. | N/A | integer |
| clientQueueDepth | The number of outstanding read and write operations to the volume. | N/A | integer |
| clusterUtilization | The amount of cluster capacity being utilized. | N/A | float |
| desiredMetadataHosts | The metadata (slice) services being migrated to if the volume metadata is being migrated between metadata services. A "null" value means the volume is not migrating. | N/A | JSON object |
| latencyUSec | The average time, in microseconds, to complete operations to the volume in the last 500 milliseconds. A "0" (zero) value means there is no I/O to the volume. | Point in time | integer |
| metadataHosts | The metadata (slice) services on which the volume metadata resides. Possible values:
|
N/A | JSON object |
| nonZeroBlocks | The total number of 4KiB blocks that contain data after the last garbage collection operation has completed. | N/A | integer |
| readBytes | The total cumulative bytes read from the volume since the creation of the volume. | Monotonically increasing | integer |
| readBytesLastSample | The total number of bytes read from the volume during the last sample period. | Point in time | integer |
| readLatencyUSec | The average time, in microseconds, to complete read operations to the volume in the last 500 milliseconds. | Point in time | integer |
| readLatencyUSecTotal | The total time spent performing read operations from the volume. | Monotonically increasing | integer |
| readOps | The total read operations to the volume since the creation of the volume. | Monotonically increasing | integer |
| readOpsLastSample | The total number of read operations during the last sample period. | Point in time | integer |
| samplePeriodMSec | The length of the sample period, in milliseconds. | N/A | integer |
| throttle | A floating value between 0 and 1 that represents how much the system is throttling clients below their maxIOPS because of re-replication of data, transient errors, and snapshots taken. | N/A | float |
| timestamp | The current time in UTC+0 format. | N/A | ISO 8601 date string |
| unalignedReads | The total cumulative unaligned read operations to a volume since the creation of the volume. | Monotonically increasing | integer |
| unalignedWrites | The total cumulative unaligned write operations to a volume since the creation of the volume. | Monotonically increasing | integer |
| volumeAccessGroups | The list of IDs of volume access group(s) to which a volume belongs. | N/A | integer array |
| volumeID | The ID of the volume. | N/A | integer |
| volumeSize | Total provisioned capacity in bytes. | N/A | integer |
| volumeUtilization | A floating point value that describes how fully the client is using the volume's input / output capabilities in comparison with the maxIOPS QoS setting for that volume. Possible values:
|
N/A | float |
| writeBytes | The total cumulative bytes written to the volume since the creation of the volume. | Monotonically increasing | integer |
| writeBytesLastSample | The total number of bytes written to the volume during the last sample period. | Monotonically increasing | integer |
| writeLatencyUSec | The average time, in microseconds, to complete write operations to a volume in the last 500 milliseconds. | Point in time | integer |
| writeLatencyUSecTotal | The total time spent performing write operations to the volume. | Monotonically increasing | integer |
| writeOps | The total cumulative write operations to the volume since the creation of the volume. | Monotonically increasing | integer |
| writeOpsLastSample | The total number of write operations during the last sample period. | Point in time | integer |
| zeroBlocks | The total number of empty 4KiB blocks without data after the last round of garbage collection operation has completed. | Point in time | integer |