REST endpoints: Monitoring

REST

These ~~endpoints:~~endpoints ~~Monitoring~~mirror the CLI commands described in Health and capacity, Historical monitoring, Live monitoring, Tiering monitoring. Each endpoint runs the CLI command named under its heading, so the behavior, defaults, and restrictions are the same; this page lists how to call it over REST.

Conventions that apply to every endpoint (request format, the async and outputType parameters, and the response envelope) are in Requests and responses. In the tables below, Required is Yes when the parameter must always be supplied, No when it is optional, and Depends when it is required only in some combinations (for example, either an application and volume, or a consistency group ID); the CLI chapter for the same command explains the combinations.

`GET /monitoring/alua/live`

Monitor optimized and unoptimized IOPS.

CLI command: monitoring alua live

This endpoint takes no parameters.

Response: a list of MonitoringAluaElement objects in Result.MonitoringAluaElement, each with: VolumeFullName (string), optimizedIops (integer), unoptimizedIops (integer).

`GET /monitoring/capacity/pools/current`

Show current capacity consumption statistics.

CLI command: monitoring capacity pools current

Query parameters

Name Type Required Description details boolean No Show capacity distribution information. allocation boolean No Show allocation in addition to consumption.

Response: an object of type MonitoringCapacity in Result, with: CapacityUsage (array of CapacityUsageElement), ChartsFileInfo (array of ChartFile).

`GET /monitoring/capacity/pools/history`

Show historic capacity statistics.

CLI command: monitoring capacity pools history

Query parameters

Name Type Required Description hdd boolean No Show HDD capacity. ssd boolean No Show SSD capacity. nvme boolean No Show NVMe capacity. manualPools boolean No Show manual pools capacity. fromDate date-time No Filter by start date/time, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). toDate date-time No Filter by end date/time, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). interval integer No The sampling interval in minutes. force boolean No Do not ask for approval when displaying predicted values.

Response: an object of type MonitoringCapacityHistory in Result, with: PerformanceStatstics (array of CapacityHistoryElement), ChartsFileInfo (array of ChartFile).

`GET /monitoring/capacity/provisioning`

Show pool thin provisioning states.

CLI command: monitoring capacity provisioning

This endpoint takes no parameters.

Response: a list of PoolNPlusKThinProvisioningState objects in Result.

`GET /monitoring/capacity/volumes`

Show volume capacity allocation and consumption.

CLI command: monitoring capacity volumes

This endpoint takes no parameters.

Response: a list of ApplicationElement objects in Result, each with: Application (string), Template (string), Description (string), Volumes (array of VolumeElement), ConsistencyGroups (array of ConsistencyGroupElement), Vms (array of VmElement), InitializeForTesting (boolean), Force (boolean).

`GET /monitoring/drives/live`

Show live drive statistics.

CLI command: monitoring drives live

Query parameters

Name Type Required Description node string No Filter results for a specific node only. pools array of string No Filter results for a specific pool only. drives array of integer No Filter results for specific drives. aggr boolean No Aggregate results for the entire pool / specific drives. iops boolean No Show input/output operations per second. throughput boolean No Show throughput. latency boolean No Show latency. iosize boolean No Show I/O size. read boolean No Show read statistics. write boolean No Show write statistics.

Response: a list of MonitoringDrivesLive objects in Result.MonitoringDrivesstats.

`GET /monitoring/health/current`

See S1's hardware and software health.

CLI command: monitoring health current

Query parameters

Name Type Required Description volumes boolean No Show volumes health. hardwareResources boolean No Show hardware health. hardwareUtilization boolean No Show hardware utilization. capacityUtilization boolean No Show capacity utilization. details boolean No Show a detailed breakdown for each selected category.

Response: an object of type MonitoringHealth in Result, with: Volumes (VolumesHealthElement), HardwareResources (HardwareResourcesHealth), HardwareUtilization (HardwareUtilizationElement), CapacityUtilization (BasicCapacityElement).

`GET /monitoring/performance/history`

Show historic performance statistics.

CLI command: monitoring performance history

Query parameters

Name Type Required Description system boolean Depends See system-wide performance. application string Depends See results for an application. volumes array of string No See results for specific volumes. iops boolean No Show input/output operations per second. throughput boolean No Show throughput. latency boolean No Show latency. iosize boolean No Show I/O size. readOnly boolean No Show only read stats. writeOnly boolean No Show only write stats. aggrReadsWrites boolean No Combine read and write stats. fromDate date-time No Filter by start date/time, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). toDate date-time No Filter by end date/time, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). interval integer No The sampling interval in minutes.

Response: an object of type MonitoringPerformanceHistory in Result, with: PerformanceStatstics (array of EntityHistoryPerformanceStatsElement), ChartsFileInfo (array of ChartFile).

`GET /monitoring/performance/live`

Show live performance statistics.

CLI command: monitoring performance live

Query parameters

Name Type Required Description application string No Filter results for a specific application only. volumes array of string No Filter results for specific volumes. aggr boolean No Aggregate results for the entire system / specific application. iops boolean No Show input/output operations per second. throughput boolean No Show throughput. latency boolean No Show latency. iosize boolean No Show I/O size. read boolean No Show read statistics. write boolean No Show write statistics.

Response: a list of EntityPerformanceStatsElement objects in Result.Performance.

`GET /monitoring/reserve/current`

Monitor reserve space per volume.

CLI command: monitoring reserve current

Query parameters

Name Type Required Description data boolean Depends Show data reserve. metadata boolean Depends Show metadata reserve.

Response: a list of VolumeChunkReserveSpaceElement objects in Result.Reserve, each with: Name (readonly string), UsedNInBytes (number), UsedKInBytes (number), UsedDataInBytes (number), TotalChunksInBytes (number), HddChunksInBytes (number), SsdChunksInBytes (number), NvmeChunksInBytes (number), ReserveSpaceInBytes (number).

`GET /monitoring/tiers/live`

Show live evacuation statistics.

CLI command: monitoring tiers live

This endpoint takes no parameters.

Response: a list of MonitoringTieringLiveElement objects in Result, each with: LowerTierPoolNames (array of string), UpperTierPoolName (string), State (TierUsageState), UsageState (string: BelowPinnedSize / AbovePinnedSize / HighConsumption / Bypass), UpperTierUsedSizeInBytes (number), UpperTierAllocatedSizeInBytes (number), UpperTierLowerThresholdSizeInBytes (number), UpperTierHigherThresholdSizeInBytes (number), TierUsageChangePerSecondInBytes (number), IsEvacuating (boolean), IsEvacuationEnabled (boolean), IsInBypass (boolean), WasEvacuating (boolean), TierMinUsageChangeInBytes (number), TierUsageChangeInBytes_90thPrecentile (number).

`GET /monitoring/tiers/stats`

Show per-tier evacuation and usage statistics.

CLI command: monitoring tiers stats

This endpoint takes no parameters.

Response: a list of MonitoringTieringStatsElement objects in Result.MonitoringTieringStatsElement, each with: Names (array of string), TierPool (string), Samples (integer), EvacuationDurationInPercentage (number), AverageLatencyDuringEvacuationInMilliseconds (number), AverageLatencyDuringNonEvacuationInMilliseconds (number), TierUsageStatesScoreInPercentage (number), LowerAndUpperTierReadsRatioScoreInPercentage (number), EvacuationDurationScoreInPercentage (number), LatencyImpactDuringEvacuationScoreInPercentage (number), AverageUpperTierReads (number), AverageLowerTierReads (number), AverageLowerTierReadsIoSizeInBytes (number), UsedOnlyForWritesInPercentage (number), IsCurrentlyBeingUsedOnlyForWrites (boolean), TierExceededPinnedSizeDateTime (date-time), TierEvacuationOnsetDateTime (date-time), TierLastEvacuationCompletionDateTime (date-time).

`GET /monitoring/tiers/usage_distribution`

Show tiering usage distribution.

CLI command: monitoring tiers usage_distribution

This endpoint takes no parameters.

Response: a list of MonitoringTieringUsageDistributionElement objects in Result.MonitoringTieringUsageDistributionElement.

`GET /monitoring/top/volumes`

Show top volumes by IOPS, latency, or capacity.

CLI command: monitoring top volumes

Query parameters

Name Type Required Description userDataConsumedSize boolean Depends Show top volumes by data capacity consumption. retentionConsumedSize boolean Depends Show top volumes by data retention capacity consumption. iops boolean Depends Show top volumes by input/output operations per second. latency boolean Depends Show top volumes by latency. fromDate date-time No Filter by start date/time, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). Not supported with userDataConsumedSize or retentionConsumedSize. toDate date-time No Filter by end date/time, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). Not supported with userDataConsumedSize or retentionConsumedSize. limit integer No Limit the number of top volumes shown.

Response: an object of type MonitoringTopVolumes in Result, with: ChartsFileInfo (array of ChartFile), Statistics (array of VolumeStatisticElement).

`GET /monitoring/utilization/history`

Show historic utilization statistics.

CLI command: monitoring utilization history

Query parameters

Name Type Required Description node string No Filter results for a specific node. aggr boolean No Aggregate results for all nodes. hdd boolean No Show HDD utilization. ssd boolean No Show SSD utilization. nvme boolean No Show NVMe utilization. cpu boolean No Show CPU utilization. memory boolean No Show memory utilization. fromDate date-time No Filter by start date/time, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). toDate date-time No Filter by end date/time, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). interval integer No The sampling interval in minutes. force boolean No Do not ask for approval when displaying predicted values.

Response: an object of type MonitoringUtilizationHistory in Result, with: UtilizationHistoryStatstics (array of UtilizationHistoryElement), ChartsFileInfo (array of ChartFile).

`GET /monitoring/utilization/live`

Show live utilization statistics.

CLI command: monitoring utilization live

Query parameters

Name Type Required Description node string No Filter results for a specific node.

Response: a list of UtilizationLiveElement objects in Result.UtilizationStats, each with: HDDPoolsInPercentage (map of string to int), SSDPoolsInPercentage (map of string to int), NvmePoolsInPercentage (map of string to int).