View system status

Edit online

Capacity and usage of devices, storage pools, and vaults are visible from this API.

Request

Edit online

Security

Edit online
Table 1. Roles capable of executing the View System Status API method
Any Super User System Admin Security Admin Operator
  superUser systemAdmin

(readOnly and read/write)

 securityAdmin

(readOnly and read/write)

 operator

HTTP method

Edit online

GET /manager/api/{apiResponseType}/1.0/viewSystemStatus.adm HTTP/1.1 Host:{manager.dsnet} itemType={type}&id={id}&rel={item}.{relatedItem}

Curl method

Edit online

curl -u {admin}:{password} -k ”https://{manager.dsnet}/manager/api/{apiResponseType}/1.0/viewSystemStatus.adm“ -d ”itemType={type}&id={id}&rel={item}.{relatedItem}“

Request parameters

Edit online
Table 2. Request Parameters for View System Status (viewSystemStatus) API method
Parameter Type Usage Default Description
itemType   Optional none

Any entity the View System can output except Settings, Root Organization, or Event Categories. It represents the starting point of the request and must be used in tandem with the id parameter to return any results (except for dsnet, since it does not have an ID). If itemType is excluded, all the default data is returned. If an invalid option is supplied, no data is returned.

Valid values include:
  • accesspool
  • account
  • cabinet
  • device
  • dsnet
  • group
  • mirror
  • site
  • storagepool
  • storagepoolgroup
  • tag
  • vault
  • fileserverpool
  • filesystem
  • share
id long Optional none

Used in tandem with itemType. The ID of the items to request. Multiple id parameters can be added to the request to create more complex relationships and add more items to the output.
rel String Optional none

It is used to look up relationships between elements in the Manager Web Interface. This querying aspect allows the user to get more items based on their relationship to other elements in the system.

Example 3. Relating Items in the Request

An example relationship is site.devices. Adding this relationship includes all devices in any sites requested.

Most relationships are in the form ITEM.RELATED_ITEMS where site = ITEM and devices = RELATED_ITEMS in the example. Each itemType can be chosen as ITEM and then each one has 0 or more available RELATED_FIELD options.

Item Related Field
accesspool devices, vaults, mirrors, mirroredvaults
account vaults
cabinet devices
device storagepools, vaults, mirrors, hardwareprofiles
dsnet accounts, accesspools, cabinets, devices, eventcategories, groups, mirrors, deviceswithoutsite, rootorganization, settings, sites, storagepools, storagepoolgroups, tags, vaults devicesnotinaccesspool, devicesnotinstoragepool, deviceswithoutsite
group vaults
mirror accessdevices, accounts, devices, groups, storagedevices, vaults
site cabinets, devices, storagedevices, accessdevices, vaults, mirrors, storagepools, accesspools
storagepool devices, vaults, sites, cabinets
storagepoolgroup storagepools, vaulttemplates
tag vaults
vault accessdevices, storagedevices, devices, accounts, groups, storagepools, accesspools, tags
fileserverpool devices, shares
filesystem shares, vaults
share fileserverpools, filesystems

Response

Edit online

Returns success or failure status.

JSON response example

Edit online
{
  ”responseStatus“:”ok“,
  ”responseHeader“:{
    ”status“:”ok“,
    ”now“:{milliseconds from the UNIX epoch},
    ”requestId“:”U2mdCcCoDicAACdyilwAAAAF“
  },
  ”responseData“:{
    ”vaults“:[
      {
        ”accessHealth“:”all“,
        ”utilization“:14336000,
        ”storageHealth“:”ok“,
        ”id“:93,
        ”uuid“:”c435cba8-d61c-4163-94a2-6670bbe1a739“
      }
    ],
    ”cabinets“:[
      {
        ”health“:”all“,
        ”id“:1
      }
    ],
    ”storagePools“:[
      {
        ”capacity“:3913160720384,
        ”id“:48,
        ”utilization“:28672000
      }
    ],
    ”storagePoolGroups“:[
      {
        ”capacity“:3913160720384,
        ”id“:48,
        ”utilization“:28672000
      }
    ],
    ”networkNodes“:[],
    ”devices“:[
      {
        ”upgradeAborted“:false,
        ”capacity“:3913160720384,
        ”uuid“:”dfdb2bb1-405f-4c0d-a7d2-8a67f49055c0“,
        ”utilization“:0,
        ”pingable“:false,
        ”polled“:true,
        ”upgradeState“:”requiring“,
        ”upgradeErrorCode“:null,
        ”upgradeHalted“:false,
        ”version“:”3.2.3.0~beta2“,
        ”health“:”error“,
        ”deviceCommunicationErrors“: [2,5,10],
        ”pollable“:false,
        ”id“:14,
        ”processChecks“:[
          {
            ”count“:0,
            ”state“:”none“,
            ”maximumCount“:1,
            ”name“:”dsnet-core“,
            ”minimumCount“:1
          }
        ]
      },
      ...
    ],
    ”sites“:[
      {
        ”health“:”some“,
        ”id“:1
      },
      ...
    ],
    ”rootOrganization“:{
      ”id“:1
    },
    ”accounts“:[
      {
        ”id“:1,
        ”uuid“:”22aa4211-8368-4e3a-aeb6-1c5c928bf93a“
      },
      ...
    ],
    ”groups“:[
      {
        ”id“:1
      }
    ]
  }
}

Parameters

Edit online
Table 3. Response Parameters for View System Status (viewSystemStatus) API method
Parameter Type Description
vaults

array

Vaults in the system as objects. Each object includes:
id

Long

Vault ID assigned by Manager.
uuid

String

Vault's Universally Unique Identifier across the system
accessHealth

String

Health of Accesser devices that are deployed in vault:

Value

Description
unconfigured

no devices
all

all ok
none

all down
some

some down, some up
storageHealth

String

Health of Slicestor devices in vault:

Value

Description
ok

device is in healthy state
userWarning

open warning on device
readable

device is in readable state
threshold

device is at threshold
below

below threshold
unconfigured

no devices
utilization

Long

Used capacity of devices in vault
cabinets

array

Cabinets in the system
id

Long

Cabinet ID in Manager
health

String

Health of cabinet:

Value

Description
empty

no devices
all

all ok
none

all down
some

some down, some up
storagePools

array

Storage pools in the system as objects. Each object includes:

Note: It is different than what is seen in Manager UI for a storage pool. A storage pool in UI is represented by a storagePoolGroup, which can contain one or more storagePool objects.
id

Long

Manager given Storage Pool ID
utilization

Long

Used capacity of devices in storage pool
capacity

Long

Total capacity of devices in storage pool
storagePoolGroup

array

Storage pool groups in the system as objects. Viewed as a storage pool in the UI and API in all other circumstances. Each object includes:

A storage pool group is what a vault is created upon. Each storage pool group contains at least one storage pool (multiple if a merge pool action is taken).
id

Long

Manager given Storage Pool ID
utilization

Long

Used capacity of devices in storage pool
capacity

Long

Total capacity of devices in storage pool
devices

array

Approved devices that are approved in the system

For information about each key, see (List Devices).
id

Long

Device ID in Manager
capacity (Slicestors only)

Long

Raw capacity of Slicestor device
hasProcessError

Boolean

Device has a software process error
health

String

Device health:

Value

Description
ok

Device is in good health.
warning

Warning exists on device.
error

Error exists on the device.
unconfigured

Device has not been configured.
deviceCommunicationErrors

array[long]

Device IDs of devices with which this device cannot communicate.
pingable

Boolean

Device can be pinged
pollable

Boolean

Device can be polled
polled

Boolean

Device has been polled. If false, remaining parameters will not be returned.
upgradeAborted

Boolean

Device upgrade has been stopped by operator
upgradeErrorCode

String

Error that resulted
upgradeHalted

Boolean

Device upgrade has been stopped by process
upgradeState

String

  
timeUntilUpgrade

String

The value is the number of milliseconds until the device is eligible for upgrade. If this field doesn't apply (not MPS, not slicestor) it will be null.
utilization (Slicestors only)

Long

Current usage of Slicestor device
uuid

String

Universal Unique Identifier for device across entire system
version

String

Device ClevOS version
processChecks

array

List of process errors. Returned only when hasProcessError=true
{name}

String

Process name
count

Integer

Number of times process has run
state

String

Last known state of process. Should be ignored but may be either ok, none, tooFew or tooMany. As this is depreciated, it will always be none.
minimumCount

Integer

Least number of times a process should run
maximumCount

Integer

Most number of times a process should run
sites

array

Sites in the system as objects. Each object includes:

Note: For more information about each key, see (List Sites).
id

Long

Site ID assigned by Manager
health

String

Health of site:

Value

Description
empty

no devices
all

all ok
none

all down
some

some down, some up
rootOrganization

object

Information about main organization in Manager.
id

Long

Organization ID assigned by Manager
accounts

array

Accounts in the system as objects. Each object includes:

Note: For more information about each key in output, see (List Accounts).
id

Long

Account ID assigned by Manager
uuid

String

Account's Universally Unique Identifier across the system
groups

array

Groups in the system as objects. Each object includes:
id

Long

Group ID assigned by Manager