Skip to main content

Monitoring

get__monitoring_alua_live

Code samples

GET /monitoring/alua/live HTTP/1.1

Accept: application/json

GET /monitoring/alua/live

Monitor optimized and unoptimized IOPS.

Example responses

200 Response

{
  "Data": [
    {
      "VolumeFullName": "string",
      "optimizedIops": 0,
      "unoptimizedIops": 0
    }
  ]
}

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success MonitoringAluaElementApiResult
400 Bad Request Bad Request string

get__monitoring_capacity_provisioning

Code samples

GET /monitoring/capacity/provisioning HTTP/1.1

Accept: application/json

GET /monitoring/capacity/provisioning

Show pool thin provisioning states.

Example responses

200 Response

{
  "Data": [
    {
      "PoolName": "string",
      "VirtualRaidValues": [
        {
          "N": 0,
          "K": 0
        }
      ],
      "State": "Ok",
      "Reason": "None",
      "FreeSpaceInPercentage": 0.1
    }
  ]
}

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success PoolNPlusKThinProvisioningStateApiResult
400 Bad Request Bad Request string

get__monitoring_capacity_volumes

Code samples

GET /monitoring/capacity/volumes HTTP/1.1

Accept: application/json

GET /monitoring/capacity/volumes

Show volume capacity allocation and consumption.

Example responses

200 Response

{
  "Data": [
    {
      "Application": "string",
      "Template": "string",
      "Description": "string",
      "Volumes": [
        {
          "Application": "string",
          "Volume": "string",
          "VolumeEntityId": 0,
          "Id": 0,
          "MetadataVolumeEntityId": 0,
          "IsInternalVolume": true,
          "CapacityInBytes": 0,
          "SnapshotCapacityInBytes": 0,
          "Tiers": {
            "TierEntityIds": [
              0
            ],
            "TierPools": [
              "string"
            ],
            "TierN": [
              0
            ],
            "TierK": [
              0
            ],
            "TierSizesInBytes": [
              0
            ],
            "EvacuationThresholdsInPercentage": [
              0.1
            ],
            "LowerThresholdsInPercentage": [
              0.1
            ],
            "TierDataDegradationHistogram": [
              [
                0
              ]
            ],
            "TierMetadataDegradationHistogram": [
              [
                0
              ]
            ]
          },
          "IsRoot": true,
          "State": "Ok",
          "Vms": [
            "string"
          ],
          "Shares": [
            {
              "Application": "string",
              "Volume": "string",
              "Share": "string",
              "Path": "string",
              "Browsable": true,
              "RecycleBin": true,
              "ReadonlyAccess": true,
              "AllowedSubnets": [
                "string"
              ],
              "Smb": true,
              "Nfs": true
            }
          ],
          "Profile": "string",
          "Mapping": [
            {
              "Host": "string",
              "LunId": 0
            }
          ],
          "Naa": "string",
          "StatsInfo": {
            "UserDataAllocatedSizeInBytes": 0.1,
            "UserDataConsumedSizeInBytes": 0.1,
            "UpperTierAllocatedSizeInBytes": 0.1,
            "UpperTierConsumedSizeInBytes": 0.1,
            "RetentionAllocatedSizeInBytes": 0.1,
            "RetentionConsumedSizeInBytes": 0.1,
            "VRAIDAllocatedSizeInBytes": 0.1,
            "VRAIDConsumedSizeInBytes": 0.1,
            "Iops": 0.1,
            "LatencyInMilliseconds": 0.1,
            "IoSizeInBytes": 0.1,
            "ThroughputInBytes": 0.1
          },
          "FileSystemInformation": {
            "MountState": "Mounted",
            "ReplicationMetadata": "None",
            "EnableSnapone": true,
            "Profile": "string",
            "FilesystemState": "string",
            "InodeCount": "string",
            "FreeInodes": "string",
            "BlockSize": "string",
            "BlockCount": "string",
            "FreeBlocks": "string",
            "FilesystemCreated": "string",
            "LastMountTime": "string",
            "LastWriteTime": "string",
            "MountCount": "string",
            "LastChecked": "string",
            "LifeTimeWrites": "string"
          },
          "Object": {
            "Application": "string",
            "Volume": "string",
            "IP": "string",
            "FloatingIp": "string",
            "Port": 0,
            "EnableSsl": true,
            "AccessKeys": [
              "string"
            ],
            "ObjectProvider": "Minio"
          },
          "ConnectivityType": "None",
          "Replication": {
            "IpAddress": "string",
            "Port": 0,
            "Role": "Unknown",
            "InternalRole": "Unknown",
            "LocalDataStatus": "NotAvailable",
            "ReplicationPairs": [
              {
                "SyncInPercentage": 0.1,
                "ReplicationId": 0,
                "RemoteSystemName": "string",
                "RemoteSystemId": 0,
                "RemoteSystemRole": "Unknown",
                "IpAddress": "string",
                "Port": 0,
                "RemoteAppName": "string",
                "RemoteVolName": "string",
                "ReplicationProtocol": "None",
                "ConnectionStatus": "Initializing",
                "RemoteDataStatus": "NotAvailable",
                "RemoteDiskStatus": "Unknown"
              }
            ]
          },
          "Pool": "string",
          "StripedPools": [
            "string"
          ],
          "Log2StrideSectors": 0,
          "DataDegradationHistogram": [
            0
          ],
          "MetadataDegradationHistogram": [
            0
          ],
          "MetadataPool": "string",
          "StripedMetadataPools": [
            "string"
          ],
          "N": 0,
          "K": 0,
          "MetadataN": 0,
          "MetadataK": 0,
          "SectorSize": "string",
          "Cgid": 0,
          "GroupedVolume": "string",
          "DisableSpaceReclamation": true,
          "EncryptionKey": "string",
          "SaveEncryptedRecoveryKey": true,
          "Encrypted": true,
          "Uptime": "string",
          "ReadOnly": true,
          "Force": true
        }
      ],
      "ConsistencyGroups": [
        {
          "Id": 0,
          "ParentConsistencyGroupId": 0,
          "ParentSnapshotId": 0,
          "SnapshotScheduler": [
            "string"
          ],
          "IsVssBasedSnapshotScheduler": true,
          "VssInitiators": [
            "string"
          ],
          "IsDirectVssMapping": true,
          "IsAvailable": true,
          "WorkerProcess": 0,
          "Volumes": [
            {
              "Application": "string",
              "Volume": "string",
              "VolumeEntityId": 0,
              "Id": 0,
              "MetadataVolumeEntityId": 0,
              "IsInternalVolume": true,
              "CapacityInBytes": 0,
              "SnapshotCapacityInBytes": 0,
              "Tiers": {
                "TierEntityIds": [
                  0
                ],
                "TierPools": [
                  "string"
                ],
                "TierN": [
                  0
                ],
                "TierK": [
                  0
                ],
                "TierSizesInBytes": [
                  0
                ],
                "EvacuationThresholdsInPercentage": [
                  0.1
                ],
                "LowerThresholdsInPercentage": [
                  0.1
                ],
                "TierDataDegradationHistogram": [
                  [
                    0
                  ]
                ],
                "TierMetadataDegradationHistogram": [
                  [
                    0
                  ]
                ]
              },
              "IsRoot": true,
              "State": "Ok",
              "Vms": [
                "string"
              ],
              "Shares": [
                {
                  "Application": "string",
                  "Volume": "string",
                  "Share": "string",
                  "Path": "string",
                  "Browsable": true,
                  "RecycleBin": true,
                  "ReadonlyAccess": true,
                  "AllowedSubnets": [
                    "string"
                  ],
                  "Smb": true,
                  "Nfs": true
                }
              ],
              "Profile": "string",
              "Mapping": [
                {
                  "Host": "string",
                  "LunId": 0
                }
              ],
              "Naa": "string",
              "StatsInfo": {
                "UserDataAllocatedSizeInBytes": 0.1,
                "UserDataConsumedSizeInBytes": 0.1,
                "UpperTierAllocatedSizeInBytes": 0.1,
                "UpperTierConsumedSizeInBytes": 0.1,
                "RetentionAllocatedSizeInBytes": 0.1,
                "RetentionConsumedSizeInBytes": 0.1,
                "VRAIDAllocatedSizeInBytes": 0.1,
                "VRAIDConsumedSizeInBytes": 0.1,
                "Iops": 0.1,
                "LatencyInMilliseconds": 0.1,
                "IoSizeInBytes": 0.1,
                "ThroughputInBytes": 0.1
              },
              "FileSystemInformation": {
                "MountState": "Mounted",
                "ReplicationMetadata": "None",
                "EnableSnapone": true,
                "Profile": "string",
                "FilesystemState": "string",
                "InodeCount": "string",
                "FreeInodes": "string",
                "BlockSize": "string",
                "BlockCount": "string",
                "FreeBlocks": "string",
                "FilesystemCreated": "string",
                "LastMountTime": "string",
                "LastWriteTime": "string",
                "MountCount": "string",
                "LastChecked": "string",
                "LifeTimeWrites": "string"
              },
              "Object": {
                "Application": "string",
                "Volume": "string",
                "IP": "string",
                "FloatingIp": "string",
                "Port": 0,
                "EnableSsl": true,
                "AccessKeys": [
                  "string"
                ],
                "ObjectProvider": "Minio"
              },
              "ConnectivityType": "None",
              "Replication": {
                "IpAddress": "string",
                "Port": 0,
                "Role": "Unknown",
                "InternalRole": "Unknown",
                "LocalDataStatus": "NotAvailable",
                "ReplicationPairs": [
                  {
                    "SyncInPercentage": 0.1,
                    "ReplicationId": 0,
                    "RemoteSystemName": "string",
                    "RemoteSystemId": 0,
                    "RemoteSystemRole": "Unknown",
                    "IpAddress": "string",
                    "Port": 0,
                    "RemoteAppName": "string",
                    "RemoteVolName": "string",
                    "ReplicationProtocol": "None",
                    "ConnectionStatus": "Initializing",
                    "RemoteDataStatus": "NotAvailable",
                    "RemoteDiskStatus": "Unknown"
                  }
                ]
              },
              "Pool": "string",
              "StripedPools": [
                "string"
              ],
              "Log2StrideSectors": 0,
              "DataDegradationHistogram": [
                0
              ],
              "MetadataDegradationHistogram": [
                0
              ],
              "MetadataPool": "string",
              "StripedMetadataPools": [
                "string"
              ],
              "N": 0,
              "K": 0,
              "MetadataN": 0,
              "MetadataK": 0,
              "SectorSize": "string",
              "Cgid": 0,
              "GroupedVolume": "string",
              "DisableSpaceReclamation": true,
              "EncryptionKey": "string",
              "SaveEncryptedRecoveryKey": true,
              "Encrypted": true,
              "Uptime": "string",
              "ReadOnly": true,
              "Force": true
            }
          ],
          "Snapshots": [
            {
              "Id": 0,
              "Date": "2019-08-24T14:15:22Z",
              "Owner": "None"
            }
          ]
        }
      ],
      "Vms": [
        {
          "Name": "string",
          "VolumeName": "string"
        }
      ]
    }
  ]
}

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success ApplicationElementApiResult
400 Bad Request Bad Request string

get__monitoring_evacuations_live

Code samples

GET /monitoring/evacuations/live HTTP/1.1

Accept: application/json

GET /monitoring/evacuations/live

Live evacuation statistics.

Example responses

200 Response

{
  "Data": [
    {
      "Name": "string",
      "LowerTierPoolNames": [
        "string"
      ],
      "UpperTierPoolName": "string",
      "UpperTierUsedSizeInBytes": 0.1,
      "UpperTierAllocatedSizeInBytes": 0.1,
      "UpperTierLowerThresholdSizeInBytes": 0.1,
      "UpperTierHigherThresholdSizeInBytes": 0.1,
      "TierUsageChangePerSecondInBytes": 0.1,
      "IsEvacuating": true,
      "IsInBypass": true,
      "WasEvacuating": true,
      "TierMinUsageChangeInBytes": 0.1,
      "TierUsageChangeInBytes_90thPrecentile": 0.1
    }
  ]
}

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success VolumeEvacuationsStatsElementApiResult
400 Bad Request Bad Request string

get__monitoring_health_current

Code samples

GET /monitoring/health/current HTTP/1.1

Accept: application/json

GET /monitoring/health/current

See S1's hardware and software health.

Parameters

Name In Type Required Description
volumes query boolean false Show volumes health.
hardwareResources query boolean false Show hardware health.
hardwareUtilization query boolean false Show hardware utilization.
capacityUtilization query boolean false Show capacity utilization.
details query boolean false Show advanced results.

Example responses

200 Response

{
  "Volumes": {
    "VolumesHealthInPercentage": 0.1,
    "HealthyVolumes": 0,
    "UnhealthyVolumes": 0,
    "UnhealthyStates": {
      "property1": "Ok",
      "property2": "Ok"
    }
  },
  "HardwareResources": {
    "HardwareResourcesHealthInPercentage": 0.1,
    "UnhealthyResourceCount": {
      "property1": 0,
      "property2": 0
    }
  },
  "HardwareUtilization": {
    "HardwareUtilizationInPercentage": 0.1,
    "CPUInPercentage": 0.1,
    "MemoryInPercentage": 0.1,
    "DriveInPercentage": 0.1
  },
  "CapacityUtilization": {
    "CapacityInBytes": 0.1,
    "CapacityUsageInBytes": 0.1,
    "ProvisioningStates": [
      "Ok"
    ],
    "PoolCapacity": [
      {
        "PoolName": "string",
        "CapacityInBytes": 0.1,
        "CapacityUsageInBytes": 0.1
      }
    ],
    "PoolCapacityVirtualRaidProvisioning": [
      {
        "Name": "string",
        "FreeSpaceInPercentage": 0.1
      }
    ]
  }
}

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success MonitoringHealth
400 Bad Request Bad Request string

get__monitoring_performance_history

Code samples

GET /monitoring/performance/history HTTP/1.1

Accept: application/json

GET /monitoring/performance/history

Historic performance statistics.

Parameters

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

Example responses

200 Response

{
  "PerformanceStatstics": [
    {
      "Time": "2019-08-24T14:15:22Z",
      "EntityName": "string",
      "Iops": 0.1,
      "ReadIops": 0.1,
      "WriteIops": 0.1,
      "LatencyInMilliseconds": 0.1,
      "ReadLatencyInMilliseconds": 0.1,
      "WriteLatencyInMilliseconds": 0.1,
      "IoSizeInBytes": 0.1,
      "ReadIoSizeInBytes": 0.1,
      "WriteIoSizeInBytes": 0.1,
      "ThroughputInBytes": 0.1,
      "ReadThroughputInBytes": 0.1,
      "WriteThroughputInBytes": 0.1
    }
  ],
  "ChartsFileInfo": [
    {
      "EntityIdentifier": "string",
      "ChartMeasure": "string",
      "Path": "string"
    }
  ]
}

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success MonitoringPerformanceHistory
400 Bad Request Bad Request string

get__monitoring_performance_live

Code samples

GET /monitoring/performance/live HTTP/1.1

Accept: application/json

GET /monitoring/performance/live

Live performance statistics.

Parameters

Name In Type Required Description
application query string false Filter results for a specific application only.
volumes query array[string] false Filter results for specific volumes.
aggr query boolean false Aggregate results for the entire system / specific application.
iops query boolean false Show input/output operations per second.
throughput query boolean false Show throughput.
latency query boolean false Show latency.
iosize query boolean false Show iosize.
read query boolean false Show reads.
write query boolean false Show writes.

Example responses

200 Response

{
  "Data": [
    {
      "Time": "string",
      "Name": "string",
      "ReadIops": 0.1,
      "WriteIops": 0.1,
      "ReadLatencyInMilliseconds": 0.1,
      "WriteLatencyInMilliseconds": 0.1,
      "ReadIoSizeInBytes": 0.1,
      "WriteIoSizeInBytes": 0.1,
      "ReadThroughputInBytes": 0.1,
      "WriteThroughputInBytes": 0.1
    }
  ]
}

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success EntityPerformanceStatsElementApiResult
400 Bad Request Bad Request string

get__monitoring_reserve_current

Code samples

GET /monitoring/reserve/current HTTP/1.1

Accept: application/json

GET /monitoring/reserve/current

Monitor reserve space per volume.

Example responses

200 Response

{
  "Data": [
    {
      "Name": "string",
      "UsedDataInBytes": 0.1,
      "TotalChunksInBytes": 0.1,
      "HddChunksInBytes": 0.1,
      "SsdChunksInBytes": 0.1,
      "NvmeChunksInBytes": 0.1,
      "ReserveSpaceInBytes": 0.1
    }
  ]
}

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success VolumeChunkReserveSpaceElementApiResult
400 Bad Request Bad Request string

get__monitoring_top_volumes

Code samples

GET /monitoring/top/volumes HTTP/1.1

Accept: application/json

GET /monitoring/top/volumes

Top volumes in terms of IOPS,Latency or Capacity.

Parameters

Name In Type Required Description
userDataConsumedSize query boolean false Show top volumes by data capacity consumption.
retentionConsumedSize query boolean false Show top volumes by data retention capacity consumption.
iops query boolean false Show top volumes by input/output operations per second.
latency query boolean false Show top volumes by high latency.
fromDate query string(date-time) false Filter by date/time - start date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS).
toDate query string(date-time) false Filter by date/time - end date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS).
limit query integer(int64) false Limit the amount of top volumes to show.

Example responses

200 Response

{
  "ChartsFileInfo": [
    {
      "EntityIdentifier": "string",
      "ChartMeasure": "string",
      "Path": "string"
    }
  ],
  "Statistics": [
    {
      "Name": "string",
      "Iops": 0,
      "CapacityInBytes": 0,
      "LatencyInMilliseconds": 0.1
    }
  ]
}

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success MonitoringTopVolumes
400 Bad Request Bad Request string

get__monitoring_utilization_history

Code samples

GET /monitoring/utilization/history HTTP/1.1

Accept: application/json

GET /monitoring/utilization/history

History utilization statistics.

Parameters

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

Example responses

200 Response

{
  "UtilizationHistoryStatstics": [
    {
      "Time": "2019-08-24T14:15:22Z",
      "NodeName": "string",
      "CpuInPercentage": 0.1,
      "MemoryInPercentage": 0.1,
      "SsdInPercentage": 0.1,
      "HddInPercentage": 0.1,
      "NvmeInPercentage": 0.1
    }
  ],
  "ChartsFileInfo": [
    {
      "EntityIdentifier": "string",
      "ChartMeasure": "string",
      "Path": "string"
    }
  ]
}

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success MonitoringUtilizationHistory
400 Bad Request Bad Request string

get__monitoring_utilization_live

Code samples

GET /monitoring/utilization/live HTTP/1.1

Accept: application/json

GET /monitoring/utilization/live

Live utilization statistics.

Parameters

Name In Type Required Description
node query string false Filter results for a specific node.

Example responses

200 Response

{
  "Data": [
    {
      "Time": "string",
      "EntityName": "string",
      "CPUInPercentage": 0,
      "MemoryInPercentage": 0,
      "HDDInPercentage": 0,
      "HDDPoolsInPercentage": {
        "property1": 0,
        "property2": 0
      },
      "SSDInPercentage": 0,
      "SSDPoolsInPercentage": {
        "property1": 0,
        "property2": 0
      },
      "NvmeInPercentage": 0,
      "NvmePoolsInPercentage": {
        "property1": 0,
        "property2": 0
      }
    }
  ]
}

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success UtilizationLiveElementApiResult
400 Bad Request Bad Request string

get__monitoring_capacity_pools_current

Code samples

GET /monitoring/capacity/pools/current HTTP/1.1

Accept: application/json

GET /monitoring/capacity/pools/current

Show capacity current consumption statistics.

Parameters

Name In Type Required Description
total query boolean false Show total capacity information instead of showing it per pool.
details query boolean false Show capacity distribution information.

Example responses

200 Response

{
  "CapacityUsage": [
    {
      "PoolId": 0,
      "Name": "string",
      "RawSizeInBytes": 0.1,
      "TotalAllocatedSizeInBytes": 0.1,
      "TotalConsumedSizeInBytes": 0.1,
      "UserDataAllocatedSizeInBytes": 0.1,
      "UserDataConsumedSizeInBytes": 0.1,
      "UpperTierAllocatedSizeInBytes": 0.1,
      "UpperTierConsumedSizeInBytes": 0.1,
      "RetentionAllocatedSizeInBytes": 0.1,
      "RetentionConsumedSizeInBytes": 0.1,
      "VRAIDAllocationSizeInBytes": 0.1,
      "VRAIDConsumedSizeInBytes": 0.1,
      "MetadataSizeInBytes": 0.1,
      "ReserveSizeInBytes": 0.1,
      "OverAllocationSizeInBytes": 0.1,
      "FreeCapacityInBytes": 0.1
    }
  ],
  "ChartsFileInfo": [
    {
      "EntityIdentifier": "string",
      "ChartMeasure": "string",
      "Path": "string"
    }
  ]
}

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success MonitoringCapacity
400 Bad Request Bad Request string

get__monitoring_capacity_pools_history

Code samples

GET /monitoring/capacity/pools/history HTTP/1.1

Accept: application/json

GET /monitoring/capacity/pools/history

Show historic capacity statistics.

Parameters

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

Example responses

200 Response

{
  "PerformanceStatstics": [
    {
      "PoolName": "string",
      "Time": "2019-08-24T14:15:22Z",
      "TotalAllocatedSizeInBytes": 0.1,
      "TotalConsumedSizeInBytes": 0.1
    }
  ],
  "ChartsFileInfo": [
    {
      "EntityIdentifier": "string",
      "ChartMeasure": "string",
      "Path": "string"
    }
  ]
}

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success MonitoringCapacityHistory
400 Bad Request Bad Request string