Get file systems associated with a storage pool

NAS File Storage REST API v7 Reference

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

Retrieves file systems associated with the storage pool.

HTTP request syntax (URI)

GET <base_URI>/v7/storage/storage-pools/{id}/filesystems

Parameters

Name Type Required Values Description
id URI_PARAM Y string/number Specifies either the storage pool object ID or HNAS storage pool ID.

Return codes

Code Data Description
200 filesystem Array of file systems associated with storage pool was retrieved successfully.
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: Using the storage pool object ID

curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v7/storage/storage-pools/3530353731333035393837383639393232353a3a3a/filesystems

Response example: Using the storage pool object ID

HTTP/1.1 200 OK
 {
   "filesystems" :
        [
                {
                        "blockSize" : 32768,
                        "capacity" : 19327352832,
                        "expansionLimits" : 53687091200,
                        "filesystemId" : "8642B2069D9F4F8A0000000000000000",
                        "freeCapacity" : 16714563584,
                        "isDedupeEnabled" : false,
                        "isDedupeSupported" : false,
                        "isLogicalCapacityFreeCapacityValid" : true,
                        "isLogicalCapacityValid" : true,
                        "isNDMPRecoveryTarget" : false,
                        "isNonStrictWORM" : false,
                        "isReadCached" : false,
                        "isReadOnly" : false,
                        "isSysLocked" : false,
                        "isThinProvisioningEnabled" : false,
                        "isThinProvisioningEnabledValid" : true,
                        "isTrueSparseFileEnabled" : true,
                        "isTrueSparseFileEnabledValid" : true,
                        "isUnlimitedExpansion" : false,
                        "isWORM" : false,
                        "label" : "DimitriDevFS",
                        "logicalCapacity" : 19327352832,
                        "logicalFreeCapacity" : 16714563584,
                        "objectId" : "38363432423230363944394634463841303030303030303030303030303030303a3a3a303a3a3a4f49445f24232140255f56",
                        "status" : "MOUNTED",
                        "storagePoolId" : 9676880324761524863,
                        "usedCapacity" : 2612789248,
                        "virtualServerId" : 4
                },
                {
                        "blockSize" : 32768,
                        "capacity" : 19327352832,
                        "expansionLimits" : 19327352832,
                        "filesystemId" : "3B6BB41DC647FC060000000000000000",
                        "freeCapacity" : 1158905856,
                        "isDedupeEnabled" : false,
                        "isDedupeSupported" : false,
                        "isLogicalCapacityFreeCapacityValid" : true,
                        "isLogicalCapacityValid" : true,
                        "isNDMPRecoveryTarget" : false,
                        "isNonStrictWORM" : false,
                        "isReadCached" : false,
                        "isReadOnly" : false,
                        "isSysLocked" : false,
                        "isThinProvisioningEnabled" : false,
                        "isThinProvisioningEnabledValid" : true,
                        "isTrueSparseFileEnabled" : true,
                        "isTrueSparseFileEnabledValid" : true,
                        "isUnlimitedExpansion" : false,
                        "isWORM" : false,
                        "label" : "ErinObjSrc",
                        "logicalCapacity" : 19327352832,
                        "logicalFreeCapacity" : 1158905856,
                        "objectId" : "33423642423431444336343746433036303030303030303030303030303030303a3a3a303a3a3a4f49445f24232140255f56",
                        "status" : "MOUNTED",
                        "storagePoolId" : 9676880324761524863,
                        "usedCapacity" : 18168446976,
                        "virtualServerId" : 4
                 }
         ]
}

Request example: Using the HNAS storage pool ID

curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v7/storage/storage-pools/505793010106320088/filesystems

Response example: Using the HNAS storage pool ID

HTTP/1.1 200 OK
 {
   "filesystems" :
        [
                {
                        "blockSize" : 32768,
                        "capacity" : 19327352832,
                        "expansionLimits" : 53687091200,
                        "filesystemId" : "8642B2069D9F4F8A0000000000000000",
                        "freeCapacity" : 16714563584,
                        "isDedupeEnabled" : false,
                        "isDedupeSupported" : false,
                        "isLogicalCapacityFreeCapacityValid" : true,
                        "isLogicalCapacityValid" : true,
                        "isNDMPRecoveryTarget" : false,
                        "isNonStrictWORM" : false,
                        "isReadCached" : false,
                        "isReadOnly" : false,
                        "isSysLocked" : false,
                        "isThinProvisioningEnabled" : false,
                        "isThinProvisioningEnabledValid" : true,
                        "isTrueSparseFileEnabled" : true,
                        "isTrueSparseFileEnabledValid" : true,
                        "isUnlimitedExpansion" : false,
                        "isWORM" : false,
                        "label" : "DimitriDevFS",
                        "logicalCapacity" : 19327352832,
                        "logicalFreeCapacity" : 16714563584,
                        "objectId" : "38363432423230363944394634463841303030303030303030303030303030303a3a3a303a3a3a4f49445f24232140255f56",
                        "status" : "MOUNTED",
                        "storagePoolId" : 9676880324761524863,
                        "usedCapacity" : 2612789248,
                        "virtualServerId" : 4
                },
                {
                        "blockSize" : 32768,
                        "capacity" : 19327352832,
                        "expansionLimits" : 19327352832,
                        "filesystemId" : "3B6BB41DC647FC060000000000000000",
                        "freeCapacity" : 1158905856,
                        "isDedupeEnabled" : false,
                        "isDedupeSupported" : false,
                        "isLogicalCapacityFreeCapacityValid" : true,
                        "isLogicalCapacityValid" : true,
                        "isNDMPRecoveryTarget" : false,
                        "isNonStrictWORM" : false,
                        "isReadCached" : false,
                        "isReadOnly" : false,
                        "isSysLocked" : false,
                        "isThinProvisioningEnabled" : false,
                        "isThinProvisioningEnabledValid" : true,
                        "isTrueSparseFileEnabled" : true,
                        "isTrueSparseFileEnabledValid" : true,
                        "isUnlimitedExpansion" : false,
                        "isWORM" : false,
                        "label" : "ErinObjSrc",
                        "logicalCapacity" : 19327352832,
                        "logicalFreeCapacity" : 1158905856,
                        "objectId" : "33423642423431444336343746433036303030303030303030303030303030303a3a3a303a3a3a4f49445f24232140255f56",
                        "status" : "MOUNTED",
                        "storagePoolId" : 9676880324761524863,
                        "usedCapacity" : 18168446976,
                        "virtualServerId" : 4
                 }
        ]
}