Storage quota reports endpoint overview
Contributors
Suggest changes
Overview
Quota reports provide the current file and space consumption for a user, group, or qtree in a FlexVol or a FlexGroup volume.
Quota report APIs
The following APIs can be used to retrieve quota reports associated with a volume in ONTAP.
– GET /api/storage/quota/reports
– GET /api/storage/quota/reports/{volume_uuid}/{index}
Examples
Retrieving all the quota report records
This API is used to retrieve all the quota report records.
The following example shows how to retrieve quota report records for all FlexVol volumes and FlexGroup volumes.
# The API: GET /api/storage/quota/reports # The call: curl -X GET "https://<mgmt-ip>/api/storage/quota/reports" -H 'accept: application/hal+json' # The response: { "records": [ { "svm": { "uuid": "b68f961b-4cee-11e9-930a-005056a7f717", "name": "svm1", "_links": { "self": { "href": "/api/svm/svms/b68f961b-4cee-11e9-930a-005056a7f717" } } }, "volume": { "uuid": "314a328f-502d-11e9-8771-005056a7f717", "name": "fg", "_links": { "self": { "href": "/api/storage/volumes/314a328f-502d-11e9-8771-005056a7f717" } } }, "index": 0, "_links": { "self": { "href": "/api/storage/quota/reports/314a328f-502d-11e9-8771-005056a7f717/0" } } }, { "svm": { "uuid": "b68f961b-4cee-11e9-930a-005056a7f717", "name": "svm1", "_links": { "self": { "href": "/api/svm/svms/b68f961b-4cee-11e9-930a-005056a7f717" } } }, "volume": { "uuid": "314a328f-502d-11e9-8771-005056a7f717", "name": "fg", "_links": { "self": { "href": "/api/storage/volumes/314a328f-502d-11e9-8771-005056a7f717" } } }, "index": 1152921504606846976, "_links": { "self": { "href": "/api/storage/quota/reports/314a328f-502d-11e9-8771-005056a7f717/1152921504606846976" } } }, { "svm": { "uuid": "b68f961b-4cee-11e9-930a-005056a7f717", "name": "svm1", "_links": { "self": { "href": "/api/svm/svms/b68f961b-4cee-11e9-930a-005056a7f717" } } }, "volume": { "uuid": "314a328f-502d-11e9-8771-005056a7f717", "name": "fg", "_links": { "self": { "href": "/api/storage/volumes/314a328f-502d-11e9-8771-005056a7f717" } } }, "index": 3458764513820540928, "_links": { "self": { "href": "/api/storage/quota/reports/314a328f-502d-11e9-8771-005056a7f717/3458764513820540928" } } }, { "svm": { "uuid": "b68f961b-4cee-11e9-930a-005056a7f717", "name": "svm1", "_links": { "self": { "href": "/api/svm/svms/b68f961b-4cee-11e9-930a-005056a7f717" } } }, "volume": { "uuid": "314a328f-502d-11e9-8771-005056a7f717", "name": "fg", "_links": { "self": { "href": "/api/storage/volumes/314a328f-502d-11e9-8771-005056a7f717" } } }, "index": 4611686018427387904, "_links": { "self": { "href": "/api/storage/quota/reports/314a328f-502d-11e9-8771-005056a7f717/4611686018427387904" } } }, { "svm": { "uuid": "b68f961b-4cee-11e9-930a-005056a7f717", "name": "svm1", "_links": { "self": { "href": "/api/svm/svms/b68f961b-4cee-11e9-930a-005056a7f717" } } }, "volume": { "uuid": "314a328f-502d-11e9-8771-005056a7f717", "name": "fg", "_links": { "self": { "href": "/api/storage/volumes/314a328f-502d-11e9-8771-005056a7f717" } } }, "index": 5764607523034234880, "_links": { "self": { "href": "/api/storage/quota/reports/314a328f-502d-11e9-8771-005056a7f717/5764607523034234880" } } }, { "svm": { "uuid": "b68f961b-4cee-11e9-930a-005056a7f717", "name": "svm1", "_links": { "self": { "href": "/api/svm/svms/b68f961b-4cee-11e9-930a-005056a7f717" } } }, "volume": { "uuid": "cb20da45-4f6b-11e9-9a71-005056a7f717", "name": "fv", "_links": { "self": { "href": "/api/storage/volumes/cb20da45-4f6b-11e9-9a71-005056a7f717" } } }, "index": 0, "_links": { "self": { "href": "/api/storage/quota/reports/cb20da45-4f6b-11e9-9a71-005056a7f717/0" } } }, { "svm": { "uuid": "b68f961b-4cee-11e9-930a-005056a7f717", "name": "svm1", "_links": { "self": { "href": "/api/svm/svms/b68f961b-4cee-11e9-930a-005056a7f717" } } }, "volume": { "uuid": "cb20da45-4f6b-11e9-9a71-005056a7f717", "name": "fv", "_links": { "self": { "href": "/api/storage/volumes/cb20da45-4f6b-11e9-9a71-005056a7f717" } } }, "index": 281474976710656, "_links": { "self": { "href": "/api/storage/quota/reports/cb20da45-4f6b-11e9-9a71-005056a7f717/281474976710656" } } }, { "svm": { "uuid": "b68f961b-4cee-11e9-930a-005056a7f717", "name": "svm1", "_links": { "self": { "href": "/api/svm/svms/b68f961b-4cee-11e9-930a-005056a7f717" } } }, "volume": { "uuid": "cb20da45-4f6b-11e9-9a71-005056a7f717", "name": "fv", "_links": { "self": { "href": "/api/storage/volumes/cb20da45-4f6b-11e9-9a71-005056a7f717" } } }, "index": 1152921504606846976, "_links": { "self": { "href": "/api/storage/quota/reports/cb20da45-4f6b-11e9-9a71-005056a7f717/1152921504606846976" } } }, { "svm": { "uuid": "b68f961b-4cee-11e9-930a-005056a7f717", "name": "svm1", "_links": { "self": { "href": "/api/svm/svms/b68f961b-4cee-11e9-930a-005056a7f717" } } }, "volume": { "uuid": "cb20da45-4f6b-11e9-9a71-005056a7f717", "name": "fv", "_links": { "self": { "href": "/api/storage/volumes/cb20da45-4f6b-11e9-9a71-005056a7f717" } } }, "index": 1153202979583557632, "_links": { "self": { "href": "/api/storage/quota/reports/cb20da45-4f6b-11e9-9a71-005056a7f717/1153202979583557632" } } }, { "svm": { "uuid": "b68f961b-4cee-11e9-930a-005056a7f717", "name": "svm1", "_links": { "self": { "href": "/api/svm/svms/b68f961b-4cee-11e9-930a-005056a7f717" } } }, "volume": { "uuid": "cb20da45-4f6b-11e9-9a71-005056a7f717", "name": "fv", "_links": { "self": { "href": "/api/storage/volumes/cb20da45-4f6b-11e9-9a71-005056a7f717" } } }, "index": 2305843013508661248, "_links": { "self": { "href": "/api/storage/quota/reports/cb20da45-4f6b-11e9-9a71-005056a7f717/2305843013508661248" } } }, { "svm": { "uuid": "b68f961b-4cee-11e9-930a-005056a7f717", "name": "svm1", "_links": { "self": { "href": "/api/svm/svms/b68f961b-4cee-11e9-930a-005056a7f717" } } }, "volume": { "uuid": "cb20da45-4f6b-11e9-9a71-005056a7f717", "name": "fv", "_links": { "self": { "href": "/api/storage/volumes/cb20da45-4f6b-11e9-9a71-005056a7f717" } } }, "index": 3458764513820540928, "_links": { "self": { "href": "/api/storage/quota/reports/cb20da45-4f6b-11e9-9a71-005056a7f717/3458764513820540928" } } }, { "svm": { "uuid": "b68f961b-4cee-11e9-930a-005056a7f717", "name": "svm1", "_links": { "self": { "href": "/api/svm/svms/b68f961b-4cee-11e9-930a-005056a7f717" } } }, "volume": { "uuid": "cb20da45-4f6b-11e9-9a71-005056a7f717", "name": "fv", "_links": { "self": { "href": "/api/storage/volumes/cb20da45-4f6b-11e9-9a71-005056a7f717" } } }, "index": 3459045988797251584, "_links": { "self": { "href": "/api/storage/quota/reports/cb20da45-4f6b-11e9-9a71-005056a7f717/3459045988797251584" } } }, { "svm": { "uuid": "b68f961b-4cee-11e9-930a-005056a7f717", "name": "svm1", "_links": { "self": { "href": "/api/svm/svms/b68f961b-4cee-11e9-930a-005056a7f717" } } }, "volume": { "uuid": "cb20da45-4f6b-11e9-9a71-005056a7f717", "name": "fv", "_links": { "self": { "href": "/api/storage/volumes/cb20da45-4f6b-11e9-9a71-005056a7f717" } } }, "index": 4611686018427387904, "_links": { "self": { "href": "/api/storage/quota/reports/cb20da45-4f6b-11e9-9a71-005056a7f717/4611686018427387904" } } }, { "svm": { "uuid": "b68f961b-4cee-11e9-930a-005056a7f717", "name": "svm1", "_links": { "self": { "href": "/api/svm/svms/b68f961b-4cee-11e9-930a-005056a7f717" } } }, "volume": { "uuid": "cb20da45-4f6b-11e9-9a71-005056a7f717", "name": "fv", "_links": { "self": { "href": "/api/storage/volumes/cb20da45-4f6b-11e9-9a71-005056a7f717" } } }, "index": 4611967493404098560, "_links": { "self": { "href": "/api/storage/quota/reports/cb20da45-4f6b-11e9-9a71-005056a7f717/4611967493404098560" } } }, { "svm": { "uuid": "b68f961b-4cee-11e9-930a-005056a7f717", "name": "svm1", "_links": { "self": { "href": "/api/svm/svms/b68f961b-4cee-11e9-930a-005056a7f717" } } }, "volume": { "uuid": "cb20da45-4f6b-11e9-9a71-005056a7f717", "name": "fv", "_links": { "self": { "href": "/api/storage/volumes/cb20da45-4f6b-11e9-9a71-005056a7f717" } } }, "index": 5764607523034234880, "_links": { "self": { "href": "/api/storage/quota/reports/cb20da45-4f6b-11e9-9a71-005056a7f717/5764607523034234880" } } } ], "num_records": 15, "_links": { "self": { "href": "/api/storage/quota/reports/" } } }
Retrieving a specific quota report record
This API is used to retrieve a specific quota report record.
The following example shows how to retrieve a single quota report user record.
# The API: GET /api/storage/quota/reports/{volume.uuid}/{index} # The call: curl -X GET "https://<mgmt-ip>/api/storage/quota/reports/cf480c37-2a6b-11e9-8513-005056a7657c/281474976710656" -H 'accept: application/hal+json' # Response for quota report user record: { "svm": { "uuid": "5093e722-248e-11e9-96ee-005056a7657c", "name": "svm1", "_links": { "self": { "href": "/api/svm/svms/5093e722-248e-11e9-96ee-005056a7657c" } } }, "volume": { "uuid": "cf480c37-2a6b-11e9-8513-005056a7657c", "name": "fv", "_links": { "self": { "href": "/api/storage/volumes/cf480c37-2a6b-11e9-8513-005056a7657c" } } }, "index": 281474976710656, "type": "user", "users": [ { "name": "fred", "id" : "300008" } ], "qtree": { "name": "qt1", "id": 1, "_links": { "self": { "href": "/api/storage/qtrees/cf480c37-2a6b-11e9-8513-005056a7657c/1" } } }, "space": { "hard_limit": 41943040, "soft_limit": 31457280, "used": { "total": 10567680, "soft_limit_percent": 34, "hard_limit_percent": 25 } }, "files": { "soft_limit": 30, "hard_limit": 40, "used": { "total": 11, "soft_limit_percent": 37, "hard_limit_percent": 28 } }, "_links": { "self": { "href": "/api/storage/quota/reports/cf480c37-2a6b-11e9-8513-005056a7657c/281474976710656" } } }
Retrieving a single quota report multi-user record
# The API: GET /api/storage/quota/reports/{volume.uuid}/{index} # The call: curl -X GET "https://<mgmt-ip>/api/storage/quota/reports/cf480c37-2a6b-11e9-8513-005056a7657c/281474976710656" -H 'accept: application/hal+json' # Response for quota report multi-user record: { "svm": { "uuid": "5093e722-248e-11e9-96ee-005056a7657c", "name": "svm1", "_links": { "self": { "href": "/api/svm/svms/5093e722-248e-11e9-96ee-005056a7657c" } } }, "volume": { "uuid": "cf480c37-2a6b-11e9-8513-005056a7657c", "name": "fv", "_links": { "self": { "href": "/api/storage/volumes/cf480c37-2a6b-11e9-8513-005056a7657c" } } }, "index": 1153484454560268288, "type": "user", "users": [ { "name": "fred", "id" : "300008" }, { "name": "john", "id" : "300009" }, { "name": "smith", "id" : "300010" } ], "qtree": { "name": "qt1", "id": 1, "_links": { "self": { "href": "/api/storage/qtrees/cf480c37-2a6b-11e9-8513-005056a7657c/1" } } }, "space": { "hard_limit": 41943040, "soft_limit": 31457280, "used": { "total": 10567680, "soft_limit_percent": 34, "hard_limit_percent": 25 } }, "files": { "soft_limit": 30, "hard_limit": 40, "used": { "total": 11, "soft_limit_percent": 37, "hard_limit_percent": 28 } }, "_links": { "self": { "href": "/api/storage/quota/reports/cf480c37-2a6b-11e9-8513-005056a7657c/1153484454560268288" } } }
Retrieving a single quota report group record
# The API: GET /api/storage/quota/reports/{volume.uuid}/{index} # The call: curl -X GET "https://<mgmt-ip>/api/storage/quota/reports/cf480c37-2a6b-11e9-8513-005056a7657c/3459045988797251584" -H 'accept: application/hal+json' # Response for quota report group record: { "svm": { "uuid": "5093e722-248e-11e9-96ee-005056a7657c", "name": "svm1", "_links": { "self": { "href": "/api/svm/svms/5093e722-248e-11e9-96ee-005056a7657c" } } }, "volume": { "uuid": "cf480c37-2a6b-11e9-8513-005056a7657c", "name": "fv", "_links": { "self": { "href": "/api/storage/volumes/cf480c37-2a6b-11e9-8513-005056a7657c" } } }, "index": 3459045988797251584, "type": "group", "group": { "name" : "test_group", "id" : "500009" }, "qtree": { "name": "qt1", "id": 1, "_links": { "self": { "href": "/api/storage/qtrees/cf480c37-2a6b-11e9-8513-005056a7657c/1" } } }, "space": { "hard_limit": 41943040, "soft_limit": 31457280, "used": { "total": 10567680, "soft_limit_percent": 34, "hard_limit_percent": 25 } }, "files": { "soft_limit": 30, "hard_limit": 40, "used": { "total": 11, "soft_limit_percent": 37, "hard_limit_percent": 28 } }, "_links": { "self": { "href": "/api/storage/quota/reports/cf480c37-2a6b-11e9-8513-005056a7657c/3459045988797251584" } } }
Retrieving a single quota report tree record
# The API: GET /api/storage/quota/reports/{volume.uuid}/{index} # The call: curl -X GET "https://<mgmt-ip>/api/storage/quota/reports/cf480c37-2a6b-11e9-8513-005056a7657c/4612248968380809216" -H 'accept: application/hal+json' # Response for quota report tree record: { "svm": { "uuid": "5093e722-248e-11e9-96ee-005056a7657c", "name": "svm1", "_links": { "self": { "href": "/api/svm/svms/5093e722-248e-11e9-96ee-005056a7657c" } } }, "volume": { "uuid": "cf480c37-2a6b-11e9-8513-005056a7657c", "name": "fv", "_links": { "self": { "href": "/api/storage/volumes/cf480c37-2a6b-11e9-8513-005056a7657c" } } }, "index": 4612248968380809216, "type": "tree", "qtree": { "name": "qt1", "id": 1, "_links": { "self": { "href": "/api/storage/qtrees/cf480c37-2a6b-11e9-8513-005056a7657c/1" } } }, "space": { "hard_limit": 41943040, "soft_limit": 31457280, "used": { "total": 10567680, "soft_limit_percent": 34, "hard_limit_percent": 25 } }, "files": { "soft_limit": 30, "hard_limit": 40, "used": { "total": 11, "soft_limit_percent": 37, "hard_limit_percent": 28 } }, "_links": { "self": { "href": "/api/storage/quota/reports/cf480c37-2a6b-11e9-8513-005056a7657c/4612248968380809216" } } }
Retrieving only records enforced by non-default rules
# The call: curl -X GET "https://<mgmt-ip>/api/storage/quota/reports?show_default_records=false" -H 'accept: application/hal+json' # Response from only non-default records { "records": [ { "svm": { "uuid": "5093e722-248e-11e9-96ee-005056a7657c", "name": "svm1", "_links": { "self": { "href": "/api/svm/svms/5093e722-248e-11e9-96ee-005056a7657c" } } }, "volume": { "uuid": "cf480c37-2a6b-11e9-8513-005056a7657c", "name": "fv", "_links": { "self": { "href": "/api/storage/volumes/cf480c37-2a6b-11e9-8513-005056a7657c" } } }, "index": 4612248968380809216, "type": "tree", "qtree": { "name": "qt1", "id": 1, "_links": { "self": { "href": "/api/storage/qtrees/cf480c37-2a6b-11e9-8513-005056a7657c/1" } } }, "space": { "hard_limit": 41943040, "soft_limit": 31457280, "used": { "total": 10567680, "soft_limit_percent": 34, "hard_limit_percent": 25 } }, "files": { "soft_limit": 30, "hard_limit": 40, "used": { "total": 11, "soft_limit_percent": 37, "hard_limit_percent": 28 } }, "_links": { "self": { "href": "/api/storage/quota/reports/cf480c37-2a6b-11e9-8513-005056a7657c/4612248968380809216" } } }, { "svm": { "uuid": "5093e722-248e-11e9-96ee-005056a7657c", "name": "svm1", "_links": { "self": { "href": "/api/svm/svms/5093e722-248e-11e9-96ee-005056a7657c" } } }, "volume": { "uuid": "cf480c37-2a6b-11e9-8513-005056a7657c", "name": "fv", "_links": { "self": { "href": "/api/storage/volumes/cf480c37-2a6b-11e9-8513-005056a7657c" } } }, "index": 1153484454560268288, "type": "user", "users": [ { "name": "fred", "id" : "300008" }, { "name": "john", "id" : "300009" }, { "name": "smith", "id" : "300010" } ], "qtree": { "name": "qt1", "id": 1, "_links": { "self": { "href": "/api/storage/qtrees/cf480c37-2a6b-11e9-8513-005056a7657c/1" } } }, "space": { "hard_limit": 41943040, "soft_limit": 31457280, "used": { "total": 10567680, "soft_limit_percent": 34, "hard_limit_percent": 25 } }, "files": { "soft_limit": 30, "hard_limit": 40, "used": { "total": 11, "soft_limit_percent": 37, "hard_limit_percent": 28 } }, "_links": { "self": { "href": "/api/storage/quota/reports/cf480c37-2a6b-11e9-8513-005056a7657c/1153484454560268288" } } } ], "num_records": 2, "_links": { "self": { "href": "/api/storage/quota/reports?show_default_records=false" } } }
Retrieving quota report records with query parameters
The following example shows how to retrieve tree type quota report records.
# The API: GET /api/storage/quota/reports # The call: curl -X GET "https://<mgmt-ip>/api/storage/quota/reports?type=tree" -H 'accept: application/hal+json' # The response: { "records": [ { "svm": { "uuid": "903e54ee-6ccf-11ea-bc35-005056823577", "name": "svm1", "_links": { "self": { "href": "/api/svm/svms/903e54ee-6ccf-11ea-bc35-005056823577" } } }, "volume": { "uuid": "8812b000-6e1e-11ea-9bad-00505682cd5c", "name": "fv", "_links": { "self": { "href": "/api/storage/volumes/8812b000-6e1e-11ea-9bad-00505682cd5c" } } }, "index": 2305843013508661248, "type": "tree", "_links": { "self": { "href": "/api/storage/quota/reports/8812b000-6e1e-11ea-9bad-00505682cd5c/2305843013508661248" } } }, { "svm": { "uuid": "903e54ee-6ccf-11ea-bc35-005056823577", "name": "svm1", "_links": { "self": { "href": "/api/svm/svms/903e54ee-6ccf-11ea-bc35-005056823577" } }