List storage pools

Edit online

List the storage pools in the system. This API cannot be run by a user assigned the operator role; instead, the View System API is used. Usage of the View System API instead is generally recommended in most use-cases.

Request

Edit online

Security

Edit online

Table 1. Roles capable of executing the List Storage Pools API method
Any	Super User	System Admin	Security Admin	Operator
	superUser	systemAdmin(readOnly and read/write)

HTTP method

Edit online

GET /manager/api/{apiResponseType}/1.0/listStoragePools.adm HTTP/1.1 Host:{manager.dsnet}

Curl method

Edit online

curl -u {admin}:{password} -k ”https://{manager.dsnet}/manager/api/{apiResponseType}/1.0/listStoragePools.adm“

Parameters

Edit online

None

Response

Edit online

List of all the storage pools in the system.

JSON response example

Edit online

{
  ”responseStatus“:”ok“,
  ”responseHeader“:{
    ”status“:”ok“,
    ”now“:{milliseconds from the UNIX epoch},
    ”requestId“:”U2qeIsCoDicAACV9Ad8AAACH“
  },
  ”responseData“:{
    ”storagePools“:[
      {
        ”analyticsEnabled“:”Disabled“,
        ”capacity“:3913160720384,
        ”description“:null,
        ”utilization“:28672000,
        ”storagePools“:[
          {
            ”capacity“:3913160720384,
            ”name“:”sp1“,
            ”utilization“:28672000,
            ”devices“:[
              {
                ”alias“:”dc-s2000-1324.cleversafelabs.com (My Site)“,
                ”id“:3,
                ”ip“:”192.168.14.24“
              }
            ],
            ”width“:1,
            ”creationDate“:”Tue, 06 May 2014 21:24:19 +0000“,
            "timestamp":"1448934321000",
            ”id“:48
          }
        ],
        ”creationDate“:”Tue, 06 May 2014 21:24:19 +0000“,
        "timestamp":"1448934321000",
        ”id“:48,
        ”name“:”sp1“
      }
    ]
  }
}

Parameters

Edit online

Table 2. Response Parameters for List Storage Pools (listStoragePools) API method
Parameter	Type	Description
storagePools	array	Storage pools in the system.
id	Long	Storage pool ID.
creationDate	date	Date when storage pool was created.
name	String	Storage pool name.
description	String	Storage pool description.
analyticsEnabled	String	Enabled or Disabled depending on whether Analytics is enabled on pool.
utilization	Long	Used capacity in storage pool.
capacity	Long	Total capacity in storage pool.
storagePools	array	Usually has one value, but can have more when pools are merged. Some data is redundant with outer storagePools array.
id	Long	Storage pool ID.
name	String	Storage pool name.
creationDate	date	Date when storage pool was created.
width	Integer	Number of devices in storage pool.
devices	array	Devices in this storage pool instance.
id	Long	Device ID.
alias	String	Device alias.
ip	String	Device IP address.
timestamp	Long	UNIX time when storage pool was created.