Filesystems/{filesystemName}/pools: GET
Gets the list of storage pools in a specific file system.
Availability
Available on all IBM Storage Scale editions.
Description
The GET filesystems/{filesystemName}/pools request gets information about all the storage pools available in a particular file system. For more information about the fields in the data structures that are returned, see the topic mmlspool command.
Request URL
https://<IP address or host name of API server>:<port>/scalemgmt/v2/filesystems/fileSystemName/pools
where- filesystems
- Specifies file system as the resource of the GET call. Required.
- filesystemName
- The particular file system in which you want to get information. Required.
- pools
- The list of storage pools in the file system. Required.
Request headers
Accept: application/json
Parameters
The following parameters can be used in the request URL to customize the
request:
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. |
fields | Comma separated list of fields to be included in response. ':all:' selects all available fields. | |
filter | Filter objects by expression. For example, 'status=HEALTHY,entityType=FILESET' |
Request data
No request data.
Response data
{
"status" : {
"code" : The HTTP status code,
"message" : "The Return Status."
},
"storagePool" : [ {
"filesystemName" : "The file system name",
"storagePoolName" : "The storage pool name"
}, {
"filesystemName" : "The file system name",
"storagePoolName" : "The file system name"
} ]
}
For
more information about the fields in the following data structures, see the links at the end of this
topic.- "status":
- Return status.
- "code": "ReturnCode"
- The return code.
- "message": "ReturnMessage",
- The return message.
- "storagePool":
- An array of elements that describe the storage pools within a file systems. Each element
describes one file system and the storage pool within it.
- "filesystemName":"The File system name",
- The name of the file system.
- "storagePoolName":"The storage pool name"
- The name of the storage pool within the particular file system.
Examples
The following example gets information about storage pool name for a particular file system.
Request
data:
curl -k -u admin:admin001 -X GET --header 'accept:application/json'
'https://198.51.100.1:443/scalemgmt/v2/filesystems/objfs/pools'
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" : [ {
"filesystemName" : "objfs",
"storagePoolName" : "data"
}, {
"filesystemName" : "objfs",
"storagePoolName" : "system"
} ]
}