Filesystems/{filesystemName}/quotagracedefaults: GET

Gets the details of the default grace period set for the quota limits that are defined at the file system level. The grace period starts when soft limit that is defined for capacity or inode usage is reached. You can set grace periods for both capacity and inode limits. User can continue the data writes until the grace time expires or hard limit is reached.

Availability

Available on all IBM Storage Scale editions.

Description

The GET filesystems/filesystemName/quotagracedefaults request gets information about the default grace period set for the quotas limits that are defined at the file system level. For more information, see mmsetquota command and mmrepquota command

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v2/filesystems/filesystemName/quotagracedefaults
where
filesystems/filesystemName
The file system about which you need the default quota grace period information. Required.
quotagracedefaults
Specifies that you need to get the default quota grace period 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": {
         "next": "URL",
         "fields": "Fields specified",
         "filter": "Filter used",
         "baseUrl": "Base URL",
         "lastId": "Last ID"
             },
         "quotaGraceDefaults": [ {
             "deviceName": "File system name",
             "quotaType": "USR | GRP | FILESET",
             "blockGracePeriod": "Grace period set for capacity usage",
             "filesGracePeriod": "Grace period set for inode usage",
            ],
   },
}
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":"Paging details"
"next": "URL",
URL of the next item.
"fields": "Fields specified",
Fields specified in the request.
"filter": "Filter used",
Filters used in the request.
"baseUrl": "Base URL",
Base URL
"lastId": "Last ID",
Last item's ID.
"quotasDefaults":""
"deviceName": "File system name",
File system name.
"quotaType":"USR | GRP | FILESET"
The quota type.
"blockGracePeriod": "Grace period set for capacity usage",
Grace period set for capacity usage.
"filesGracePeriod": "Grace period set for inode usage",
Grace period set for inode usage.

Examples

The following example gets grace periods set for all file systems that are created in the system.

Request URL: 
curl -k -u admin:admin001 -X GET --header 'accept:application/json' 
"https://localhost:47443/scalemgmt/v2/filesystems/:all:/quotagracedefaults"
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."
  },
  "quotaGraceDefaults" : [ {
    "deviceName" : "gpfs1",
    "quotaType" : "GRP",
    "blockGracePeriod" : 604800,
    "filesGracePeriod" : 604800
  }, {
    "deviceName" : "gpfs1",
    "quotaType" : "FILESET",
    "blockGracePeriod" : 604800,
    "filesGracePeriod" : 604800
  }, {
    "deviceName" : "gpfs1",
    "quotaType" : "USR",
    "blockGracePeriod" : 1000,
    "filesGracePeriod" : 864000
  }, {
    "deviceName" : "mari",
    "quotaType" : "USR",
    "blockGracePeriod" : 604800,
    "filesGracePeriod" : 604800
  }, {
    "deviceName" : "mari",
    "quotaType" : "FILESET",
    "blockGracePeriod" : 604800,
    "filesGracePeriod" : 604800
  }, {
    "deviceName" : "mari",
    "quotaType" : "GRP",
    "blockGracePeriod" : 36000,
    "filesGracePeriod" : 3600
  } ]
}