Filesystems/{filesystemName}/pools/{poolName}: GET

Gets the information about a particular storage pool.

Availability

Available on all IBM Storage Scale editions.

Description

The GET filesystems/{filesystemName}/pools/{poolName} request gets information about the specified storage pool in a file system. For more information about the fields in the data structures that are returned, see mmlspool command.

Request URL

https://<IP or host name of API server>:<port>/scalemgmt/v2/filsystems/filesystemName/pools/poolName
where:
filesystem/filesystemName
Specifies the name of the file system to which the storage pools belong. Required.
pools/poolName
Specifies the storage pool about which you need information. Required.

Request headers

Accept: application/json

Request parameters

The following parameters can be used in the request URL to customize the request:
Table 1. List of parameters
Parameter name Description and applicable keywords Required/optional
filesystemName The file system name. You can also use keywords such as :all:, :all_local:, or :all_remote: Required.
PoolName The storage pool name. Required.
fields Comma separated list of fields to be included in response. ':all:' selects all available fields. Optional.

Request data

No request data.

Response data

{
  "status" : {
    "code" : The ReturnCode,
    "message" : "The ReturnMessage."
  },
  "storagePool" : [ {
    "storagePoolName" : "Name of storage pool",
    "filesystemName" : "Name of file system",
    "totalDataInKB" : Size,
    "freeDataInKB" : Size,
    "totalMetaInKB" : Size,
    "freeMetaInKB" : Size
  } ]
}   
}
"status":
Return status.
"code":"ReturnCode"
The return code.
"message": "ReturnMessage",
The return message.
"storagePool":
The array of information listing the storage pool details.
"storagePoolName": "Name",
The name of the storage pool for which information is displayed.
"filesystemName": "Name",
The name of the file system to which the storage pool belongs.
"totalDataInKB": "Size",
The total data size in KB.
"freeDataInKB": "size",
The size of free space in KB.
"totalMetaInKB": "size",
The size of metadata in KB.

Examples

The following example gets information about the storage pool System in the file system objfs.

Request data: 
curl -k -u admin:admin001 -X GET --header 'accept:application/json' 
'https://198.51.100.1:443/scalemgmt/v2/filesystems/objfs/pools/System'
Response data:
Note: In the JSON data that is returned, the return code indicates whether the command is successful. The response code 200 indicates that the command successfully retrieved the information. Error code 400 represents an invalid request and 500 represents internal server error. 
{
  "status" : {
    "code" : 200,
    "message" : "The request finished successfully."
  },
  "storagePool" : [ {
    "storagePoolName" : "system",
    "filesystemName" : "objfs",
    "totalDataInKB" : 0,
    "freeDataInKB" : 0,
    "totalMetaInKB" : 10485760,
    "freeMetaInKB" : 8889216
  } ]
}