Getting a list of storage system pools

Ops Center Analyzer REST API Reference Guide

Version

11.0.x

Audience

anonymous

Part Number

MK-99ANA003-20

You can obtain a list of storage system pools.

Execution permission

Admin, Modify

Request line

GET baseURL/v1/objects/StorageSystemPools

Request body

Not applicable.

Response body

The structure of the response body and the object attributes is as follows:

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute	Type	Description
data	anyType[]	A list of StorageSystemPool objects. For details, see the table below.
pagination	Pagination	Page information. This parameter is displayed only when the relevant resource exists.
count	int	Number of data items that meet the conditions related to this query(API).

pagination (Type: Pagination)

Attribute	Type	Description
page	integer	Page.
pageSize	integer	Size of page.
numPages	integer	Number of pages.
totalCount	integer	Number of objects.

StorageSystemPool

{
        "poolName":"...",
        "poolID":"...",
        "storageSystemID":"...",
        "storageSystemName":"...",
        "poolType":"...",
        "volumeLocation":["...", ...],
        "driveType":["...", ...],
        "raidLevel":["...", ...]
}

StorageSystemPool (Type: StorageSystemPool)

Attribute	Type	Description
poolName	string	Name of the storage system pool
poolID	string	ID of the pool
storageSystemID	string	ID of the storage system that the pool belongs to
storageSystemName	string	Name of the storage system that the pool belongs to
poolType	enum	Type of the pool (For details about the valid values, see the table E2EPoolType in List of enumerators.)
volumeLocation	enum[]	Location of the storage system in which the volume is created (For details about the valid values, see the table VolumeLocation in List of enumerators.)
driveType	enum[]	Drive type of the storage system (For details about the valid values, see the table E2EDriveType in List of enumerators.)
raidLevel	string[]	RAID level of the storage pool

Status codes

Status code	Reason phrase	Description
201	Created	Success.
400	Bad Request	The format of the request body is invalid.
401	Unauthorized	No login privilege.
412	Precondition Failed	The server is not available.
500	Internal Server Error	Server processing error.

Example code

[Request Header]
GET /Analytics/v1/objects/StorageSystemPools
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 12 Aug 2016 02:23:14 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 3a9b57bff1fdbc16e83ca7fd4a2a9f6a7d542d_YXZvNFIMehp3UB4jbmVyPGUgT3Q=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json


[Response Body]
{
  "data" : [ {
    "instanceID" : "raidPool#10000-8",
    "poolName" : "8",
    "poolID" : "8",
    "storageSystemID" : "raidStorage#10000",
    "storageSystemName" : "VSP 5500H (10000)",
    "poolType" : "HDP",
    "volumeLocation" : [ "INTERNAL" ],
    "driveType" : [ ],
    "raidLevel" : [ "RAID5 (3D+1P)" ]
  }, {
    "instanceID" : "raidPool#10000-9",
    "poolName" : "9",
    "poolID" : "9",
    "storageSystemID" : "raidStorage#10000",
    "storageSystemName" : "VSP 5500H (10000)",
    "poolType" : "HDP",
    "volumeLocation" : [ "INTERNAL" ],
    "driveType" : [ ],
    "raidLevel" : [ "RAID5 (3D+1P)" ]
  ........  } ],
  "count" : 2
}