/scalemgmt/v3/filesystems/{filesystem}/quotas: PUT

Sets an IBM Storage Scale Quota for a filesystem.

Availability

Available on all IBM Storage Scale editions.

Description

The PUT filesystems/{filesystem}/quotas request sets quota limits for a file system in the IBM Storage Scale cluster.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v3/filesystems/{filesystem}/quotas

where

filesystem: Specifies the file system name.
quotas: Specifies the quotas as the target of the PUT call.

Request headers

Accept: application/json
Content-Type: application/json

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
filesystem	The file system name.	Required.
default	Set default quota limits for user, group, and fileset quota types.	Optional.
X-StorageScaleDomain	The domain to be authorized against for the request. The default value is `StorageScaleDomain`.	Optional.

Request data

{
  "quota": {
      "block_grace": "string",
      "block_hard_limit_bytes": "string",
      "block_soft_limit_bytes": "string",
      "file_grace": "string",
      "file_hard_limit": "string",
      "file_soft_limit": "string",
      "name": "string",
      "type": "QUOTA_TYPE_USER"
  }
}

Response data

200: A successful response indicate the LRO job completed. Check the operation response for detailed results.
```
{
  "name": "string",
  "done": true
}
```
202: The request has been accepted for processing, but the processing has not been completed.
```
{
  "name": "string",
  "done": false
}
```

default: An unexpected error response.

{
  "code": 0,
  "details": [
    {
      "@type": "string",
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  ],
  "message": "string"
}

Examples

The following example sets a quota for filesystem "fs1":

Request data:

curl -X 'PUT' \
  'https://localhost:46443/scalemgmt/v3/filesystems/fs1/quotas' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "quota": {
    "quotaType": "user",
    "blockQuota": "20480",
    "blockLimit": "40960",
    "filesQuota": "2000",
    "filesLimit": "4000"
  }
}'

Response data:

{
  "name": "operations/quota-set-002",
  "done": true
}