Get virtual volume quotas for a file system

NAS File Storage REST API v7 Reference

Version
14.7.x
14.6.x
Audience
anonymous
Part Number
MK-92HNAS088-05

Retrieves all quotas associated with all virtual volumes in a file system. This includes all quotas of all virtual volumes such as user/group quota of all virtual volumes and anonymous virtual volume quota of all virtual volumes. Note that if there are a lot of virtual volume quotas, this function will return a large amount of data.

Note:

Virtual volume user/group quota is different from file system user/group quota. Virtual volume user/group quota is limited to the quota of the virtual volumes.

HTTP request syntax (URI)

GET <base_URI>/v7/storage/quotas/{virtualServerId}/filesystem/{filesystemId}

Parameters

Name Type Required Values Description
virtualServerId URI_PARAM Y number Virtual server identifier number.
filesystemId URI_PARAM Y string Unique identity of the file system.

Return codes

Code Data Description
200 virtualVolumeQuota An array of virtualVolumeQuota objects is returned.
400 No Data Missing or invalid request contents.
404 Error Message Requested resource not found.
500 Error message Error associated with the storage system.
501 No Data Server has not implemented the request operation on the resource.

Any HTTP status code other than 200 indicates that the API did not complete successfully.

Request example

curl -vk -H "X-Api-Key: Td5qNSpXX4.732uVwjjuN1Wgmxw7yJwL5nygQk79k6pbVg.wvMFqH2" https://172.27.250.210:8444/v7/storage/quotas/2/filesystem/AF0BFEDC1CF3BCC70000000000000000 

Response example

HTTP/1.1 200 Ok
{
   "virtualVolumeQuotas" : [
      {
         "filesystemId" : "AF0BFEDC1CF3BCC70000000000000000",
         "objectId" : "323a3a3a41463042464544433143463342434337303030303030303030303030303030303a3a3a313a3a3a303a3a3a4f49445f24232140255f56",
         "quota" : {
            "diskUsage" : 0,
            "diskUsageThreshold" : {
               "isHard" : false,
               "limit" : 0,
               "reset" : 5,
               "severe" : 85,
               "warning" : 75
            },
            "fileCountThreshold" : {
               "isHard" : false,
               "limit" : 0,
               "reset" : 5,
               "severe" : 85,
               "warning" : 75
            },
            "fileUsage" : 0,
            "logEvent" : false,
            "targetDomain" : "",
            "targetName" : "nfsuser",
            "targetType" : "USER"
         },
         "virtualServerId" : 2,
         "virtualVolumeId" : 1,
         "virtualVolumeName" : "vv1"
      },
      {
         "filesystemId" : "AF0BFEDC1CF3BCC70000000000000000",
         "objectId" : "323a3a3a41463042464544433143463342434337303030303030303030303030303030303a3a3a313a3a3a303a3a3a4f49445f24232140255f56",
         "quota" : {
            "diskUsage" : 0,
            "diskUsageThreshold" : {
               "isHard" : true,
               "limit" : 6442450944,
               "reset" : 5,
               "severe" : 85,
               "warning" : 75
            },
            "fileCountThreshold" : {
               "isHard" : false,
               "limit" : 0,
               "reset" : 5,
               "severe" : 85,
               "warning" : 75
            },
            "fileUsage" : 0,
            "logEvent" : false,
            "targetDomain" : "",
            "targetName" : "nfsgroup",
            "targetType" : "GROUP"
         },
         "virtualServerId" : 2,
         "virtualVolumeId" : 1,
         "virtualVolumeName" : "vv1"
      },
      {
         "filesystemId" : "AF0BFEDC1CF3BCC70000000000000000",
         "objectId" : "323a3a3a41463042464544433143463342434337303030303030303030303030303030303a3a3a313a3a3a303a3a3a4f49445f24232140255f56",
         "quota" : {
            "diskUsage" : 0,
            "diskUsageThreshold" : {
               "isHard" : true,
               "limit" : 24696061952,
               "reset" : 5,
               "severe" : 85,
               "warning" : 75
            },
            "fileCountThreshold" : {
               "isHard" : true,
               "limit" : 90000,
               "reset" : 5,
               "severe" : 85,
               "warning" : 75
            },
            "fileUsage" : 1,
            "logEvent" : false,
            "targetDomain" : "",
            "targetName" : "",
            "targetType" : "VIRTUAL_VOLUME"
         },
         "virtualServerId" : 2,
         "virtualVolumeId" : 1,
         "virtualVolumeName" : "vv1"
      },
      {
         "filesystemId" : "AF0BFEDC1CF3BCC70000000000000000",
         "objectId" : "323a3a3a41463042464544433143463342434337303030303030303030303030303030303a3a3a323a3a3a303a3a3a4f49445f24232140255f56",
         "quota" : {
            "diskUsage" : 0,
            "diskUsageThreshold" : {
               "isHard" : true,
               "limit" : 1234567890,
               "reset" : 65,
               "severe" : 95,
               "warning" : 75
            },
            "fileCountThreshold" : {
               "isHard" : false,
               "limit" : 1000,
               "reset" : 85,
               "severe" : 95,
               "warning" : 90
            },
            "fileUsage" : 0,
            "logEvent" : true,
            "targetDomain" : "",
            "targetName" : "xyz.com",
            "targetType" : "USER"
         },
         "virtualServerId" : 2,
         "virtualVolumeId" : 2,
         "virtualVolumeName" : "xyzvvol-test1"
      },
      {
         "filesystemId" : "AF0BFEDC1CF3BCC70000000000000000",
         "objectId" : "323a3a3a41463042464544433143463342434337303030303030303030303030303030303a3a3a323a3a3a303a3a3a4f49445f24232140255f56",
         "quota" : {
            "diskUsage" : 0,
            "diskUsageThreshold" : {
               "isHard" : true,
               "limit" : 1234567890,
               "reset" : 65,
               "severe" : 95,
               "warning" : 75
            },
            "fileCountThreshold" : {
               "isHard" : false,
               "limit" : 1000,
               "reset" : 85,
               "severe" : 95,
               "warning" : 90
            },
            "fileUsage" : 0,
            "logEvent" : true,
            "targetDomain" : "BUILTIN",
            "targetName" : "Current Owner",
            "targetType" : "USER"
         },
         "virtualServerId" : 2,
         "virtualVolumeId" : 2,
         "virtualVolumeName" : "xyzvvol-test1"
      },
      {
         "filesystemId" : "AF0BFEDC1CF3BCC70000000000000000",
         "objectId" : "323a3a3a41463042464544433143463342434337303030303030303030303030303030303a3a3a323a3a3a303a3a3a4f49445f24232140255f56",
         "quota" : {
            "diskUsage" : 0,
            "diskUsageThreshold" : {
               "isHard" : true,
               "limit" : 1234567890,
               "reset" : 65,
               "severe" : 95,
               "warning" : 75
            },
            "fileCountThreshold" : {
               "isHard" : false,
               "limit" : 1000,
               "reset" : 85,
               "severe" : 95,
               "warning" : 90
            },
            "fileUsage" : 1,
            "logEvent" : true,
            "targetDomain" : "",
            "targetName" : "",
            "targetType" : "VIRTUAL_VOLUME"
         },
         "virtualServerId" : 2,
         "virtualVolumeId" : 2,
         "virtualVolumeName" : "xyzvvol-test1"
      }
   ]
}