Version history report

Generates the Version History Report to view the Software version history for a particular device or all devices.

Note: This API is rate-limited. The manager application processes a maximum number of RESTful requests concurrently to avoid excessive memory consumption. The maximum number of requests is 2. If the maximum is reached, subsequent requests are blocked for at most 20 seconds. If 20 seconds is exceeded, the request gets an immediate response with an HTTP status code 429.

Request

Edit online

Security

Edit online

Table 1. Roles capable of executing the Version History Report API method
Any	Super User	System Admin	Security Admin	Operator
	superUser	systemAdmin (readOnly and read/write)		operator

HTTP method

Edit online

GET /manager/api/{apiResponseType}/1.0/versionHistoryReport.adm HTTP/1.1 Host:{manager.dsnet} deviceIds={deviceId1,deviceId2,deviceId3}&deviceTypes={manager,accesser,slicestor,gateway} &accessPoolIds={accessPoolId1,accessPoolId2,accessPoolId3} &fileServerPoolIds={fileServerPoolId1,fileServerPoolId2,fileServerPoolId3} &storagePoolGroupIds={storagePoolGroupId1,storagePoolGroupId2,storagePoolGroupId3} &storagePoolIds={storagePoolId1,storagePoolId2,storagePoolId3} &startTimestamp={startTimestamp}&endTimestamp={endTimestamp} &version={version}

Curl method

Edit online

curl -u {admin}:{password} -k ”https://{manager.dsnet}/manager/api/{apiResponseType}/1.0/versionHistoryReport.adm“ -d ”deviceIds={deviceId1,deviceId2,deviceId3}&deviceTypes={manager,accesser,slicestor,gateway} &accessPoolIds={accessPoolId1,accessPoolId2,accessPoolId3} &fileServerPoolIds={fileServerPoolId1,fileServerPoolId2,fileServerPoolId3} &storagePoolGroupIds={storagePoolGroupId1,storagePoolGroupId2,storagePoolGroupId3} &storagePoolIds={storagePoolId1,storagePoolId2,storagePoolId3} &startTimestamp={startTimestamp}&endTimestamp={endTimestamp} &version={version}“

Parameters

Edit online

Table 2. Request parameters for Version History Report (versionHistoryReport) API method
Parameter	Type	Usage	Default	Description
deviceIds	List	Optional		Devices by ID for which to gather data. Multiple device IDs can be sent as deviceIds=1,2,3.
deviceTypes	List	Optional		Devices by type for which to gather data. Valid deviceTypes are manager, accesser, and slicestor. Multiple device types can be sent as deviceTypes=manager,accesser,slicestor,gateway.
storagePoolGroupIds	List	Optional		Devices from within the storage pool groups by ID, for which to gather data. Note: It is what is typically thought of as a Storage Pool in UI, or via createStoragePool or similar APIs. Each storagePoolGroup contains at least one storagePool, but might have more if it was merged with another storage pool. Multiple storage pool group IDs can be sent as storagePoolGroupIds=1,2,3.
storagePoolIds	List	Optional		Devices from within the storage pools by ID, for which to gather data. Note: It is different than what you see in UI for a storage pool (see storagePoolGroup). Multiple storage pool IDs can be sent as storagePoolIds=1,2,3.
startTimestamp	Long	Optional	30 days before now	Filter results from start date. Sent as a UNIX time stamp in milliseconds.
endTimestamp	Long	Optional		Filter results to end date. Sent as a UNIX time stamp in milliseconds.
version	String	Optional		Filter results by Software version. Sent as string to match from beginning of version name.
accessPoolIds	List	Optional		Devices from within the access pools by ID, for which to gather data. Multiple access pool IDs can be sent as accessPoolIds=1,2,3.
fileServerPoolIds	List	Optional		Devices from within the file server pools by ID, for which to gather data. Multiple file server pool IDs can be sent as fileServerPoolIds=1,2,3.

Response

Edit online

Returns success or failure status.

JSON response example

Edit online

{
  ”responseStatus“: ”ok“,
  ”responseHeader“: {
    ”now“: {milliseconds from the UNIX epoch},
    ”status“: ”ok“,
    ”requestId“: null
  },
  ”responseData“: {
    ”devices“: [
      {
        ”id“: 1,
        ”deviceType“: ”manager“,
        ”hostname“: ”dc-m2105-2215.cleversafelabs.com“,
        ”alias“: ”dc-m2105-2215.cleversafelabs.com“,
        "ip": "127.0.1.1",
        ”versions“: [
          {
            ”version“: ”3.7.0.91“,
            ”creationDate“: ”Thu, 29 Oct 2015 11:52:03 -0500“,
            ”timestamp“: ”1446137523686“
          },
          {
            ”version“: ”3.7.0.93“,
            ”creationDate“: ”Sat, 31 Oct 2015 07:56:01 -0500“,
            ”timestamp“: ”1446296161287“
          },
          {
            ”version“: ”3.7.0.96“,
            ”creationDate“: ”Mon, 09 Nov 2015 08:55:48 -0600“,
            ”timestamp“: ”1447080948275“
          }
        ]
      },
      {
        ”id“: 2,
        ”deviceType“: ”accesser“,
        ”hostname“: ”dc-a2000-2228.cleversafelabs.com“,
        ”alias“: ”dc-a2000-2228.cleversafelabs.com“,
        "ip": "127.0.1.2",
        ”accessPool“: {
          ”id“: 1,
          ”name“: ”accPool“
        },
        ”versions“: [
          {
            ”version“: ”3.7.0.91“,
            ”creationDate“: ”Thu, 29 Oct 2015 13:58:57 -0500“,
            ”timestamp“: ”1446145137272“
          },
          {
            ”version“: ”3.7.0.96“,
            ”creationDate“: ”Thu, 10 Dec 2015 12:22:44 -0600“,
            ”timestamp“: ”1449771764797“
          }
        ]
      },
      {
        "id": 3,
        "deviceType": "gateway",
        "hostname": "g2000-1234.cleversafelabs.com",
        "alias": "g2000-1234.cleversafelabs.com",
        "ip": "127.0.1.3",
        "fileServerPool": {
          "id": 4,
          "name": "FSP1"
        },
        "versions": [
          {
            "version": "3.8.1.4",
            "creationDate": "Thu, 29 Oct 2015 13:58:57 -0500",
            "timestamp": "1446145137272"
          },
          {
            "version": "3.8.0.96",
            "creationDate": "Thu, 10 Dec 2015 12:22:44 -0600",
            "timestamp": "1449771764797"
          }
        ]
      },
      {
        ”id“: 8,
        ”deviceType“: ”slicestor“,
        ”hostname“: ”mvm15.cleversafelabs.com“,
        ”alias“: ”mvm15.cleversafelabs.com“,
        "ip": "127.0.1.4",
        ”totalSize“: 85087404032,
        ”allocatedSize“: 427745280,
        ”storagePool“: {
            ”id“: 19,
            ”name“: ”vm2 - Set2“,
            ”storagePoolGroup“: {
                ”id“: 13,
                ”name“: ”vm2“
            }
        },
        ”versions“: [
          {
            ”version“: ”3.7.0.83“,
            ”creationDate“: ”Thu, 29 Oct 2015 13:58:02 -0500“,
            ”timestamp“: ”1446145082806“
          },
          {
            ”version“: ”3.7.0.91“,
            ”creationDate“: ”Thu, 29 Oct 2015 14:00:42 -0500“,
            ”timestamp“: ”1446145242492“
          }
        ]
      }
    ]
  }
}

Parameters

Edit online

Table 3. Response parameters for Version History Report (versionHistoryReport) API method
Parameter	Type	Description
devices	array	Devices in the system. Each object in array includes:
id	Long	Device ID.
deviceType	DeviceType	Device type.
hostname	String	Device host name.
alias	String	Device alias.
ip	String	Device IP address.
totalSize	BigInteger	Total size for a Slicestor device.
allocatedSize	BigInteger	Allocated size for a Slicestor device.
storagePool	object	Storage pool for a Slicestor device. Note: It is different than what you see in UI for a storage pool (see storagePoolGroup). Object includes:
id	Long	Storage pool ID.
name	String	Storage pool name.
storagePoolGroup	object	Storage pool group for a slicestor device. Note: It is what is typically thought of as a Storage Pool in the UI, or via createStoragePool or similar APIs. Each storagePoolGroup contains at least one storagePool, but might have more if it was merged with another storage pool.
id	Long	Storage pool group ID.
name	String	Storage pool group name.
accessPool	object	Access pool for an Accesser device. Object includes:
id	Long	Access pool ID.
name	String	Access pool name.
versions	array	Software versions for a device. Each object in array includes:
version	String	Name of the Software version.
creationDate	Date	Date of Software installation, readable.
timestamp	Long	UNIX time stamp of Software installation, in milliseconds.
fileServerPool	object	File server pool for a gateway device.
id	Long	File server pool ID.
name	String	File server pool name.