Filesystems/{filesystemName}/quotas: GET

Gets information about quota set at the file system level. With no parameters, all quota limits are returned.

Availability

Available on all IBM Spectrum Scale™ editions.

Description

The GET filesystems/filesystemName/quotas request gets information about quotas set at file system level. mmsetquota command and mmrepquota command

The perfileset quota must be disabled to display the user and group quotas. The fileset quota is also available in the response data.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v2/filesystems/filesystemName/quotas

where

filesystems/filesystemName: The file system about which you need the information. Required.
quotas: Specifies that you need to get the quota details. 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 request 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.
fields	Comma separated list of fields to be included in response. ':all:' selects all available fields.	Optional.
filter	Filter objects by expression. For example, 'status=HEALTHY,entityType=FILESET'	Optional.

Request data

No request data.

Response data

      {  
         "status": {
             "code":ReturnCode,
             "message":"ReturnMessage"
      },
         "paging":"{NFSv4} ",
         "quotas": [
                "quotaID":"ID",
                "filesystemName":"File system name",
                "filesetName":"Fileset name",
                "quotaType":"Type",
                "objectName":"Name",
                "objectId":"ID",
                "blockUsage":"Usage",
                "blockQuota":"Soft limit",
                "blockLimit":"Hard limit",
                "blockInDoubt":"Space in doubt",
                "blockGrace":"Grace period",
                "filesUsage":"Number of files in usage",
                "filesQuota":"Soft limit",
                "filesLimit":"Hard limit",
                "filesInDoubt":"Files in doubt",
                "filesGrace":"Grace period",
                "isDefaultQuota":"Default",
          ],
   
}

For more information about the fields in the following data structures, see the links at the end of this topic.

"status":

Return status.

"message": "ReturnMessage",: The return message.
"code": ReturnCode: The return code.

"paging":"NFSv4"

"quotas":""

"quotaID":"ID": Internal ID used for paging.
"filesystemName":"File system name": The file system for which the quota is applicable.
"filesetName":"Fileset name": The fileset for which the quota is applicable.
"quotaType":"USR | GRP | FILESET": The quota type.
"objectName":"Name": Name of the fileset, user, or user group for which the quota is applicable.
"objectId":"ID": Unique identifier of the fileset, user, or user group.
"blockUsage":"Usage": Current capacity quota usage.
"blockQuota":"Soft limit": The soft limit set for the fileset, user, or user group.
"blockLimit":"Hard limit": The hard limit set for the capacity quota usage. A grace period starts when the hard limit is reached.
"blockInDoubt":"Space in doubt": The capacity that is in doubt.
"blockGrace":"Grace period": The grace period set for the capacity quota.
"filesUsage":"Number of files in usage": Number of inodes.
"filesQuota":"Soft limit": The soft limit set for the inode quota.
"filesLimit":"Hard limit": The hard limit set for the inode quota.
"filesInDoubt":"Files in doubt": The files that are in doubt.
"filesGrace":"Grace period": The grace period set for the inode usage.
"isDefaultQuota":"Default": Default quota.

Examples

The following example gets quota information for the file system gpfs0.

Request URL:

curl -k -u admin:admin001 -X GET --header 'accept:application/json' 
'https://198.51.100.1:443/scalemgmt/v2/filesystems/gpfs0/quotas'

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": "..."
  },
  "paging": {
    "next": "https://localhost:443/scalemgmt/v2/filesystems/gpfs0/quotas?lastId=1001"
  },
  "quotas": [
    {
      "quotaId": "4711",
      "filesystemName": "gpfs0",
      "filesetName": "myFset1",
      "quotaType": "USR",
      "objectName": "myFset1",
      "objectId": "128",
      "blockUsage": "0",
      "blockQuota": "2048",
      "blockLimit": "4096",
      "blockInDoubt": "1024",
      "blockGrace": "none",
      "filesUsage": "32",
      "filesQuota": "50",
      "filesLimit": "100",
      "filesInDoubt": "3",
      "filesGrace": "none",
      "isDefaultQuota": false
    }
  ]
}