Get a file system
Retrieves detailed information about a file system on the storage system.
HTTP request syntax (URI)
GET <base_URI>/v7/storage/filesystems/{id}
Parameters
| Name | Type | Required | Values | Description |
| id | URI_PARAM | Y | string | Either the object ID or HNAS file system ID. |
Return codes
| Code | Data | Description |
| 200 | filesystem | File system object 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: Get a file system using the object ID
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.12.44.55:8444/v7/storage/filesystems/38363442313232384142423134344143303030303030303030303030303030303a3a3a303a3a3a4f49445f24232140255f56
Response example: Get a file system using the object ID
HTTP/1.1 200 OK
{
"filesystem" :
{
"blockSize" : 32768,
"capacity" : 58518929408,
"expansionLimits" : 107374182400,
"filesystemId" : "864B1228ABB144AC0000000000000000",
"freeCapacity" : 18763251712,
"isDedupeEnabled" : true,
"isDedupeSupported" : true,
"isLogicalCapacityFreeCapacityValid" : true,
"isLogicalCapacityValid" : true,
"isNDMPRecoveryTarget" : false,
"isNonStrictWORM" : false,
"isObjectReplicationTarget" : false,
"isReadCached" : false,
"isReadOnly" : false,
"isSysLocked" : true,
"isThinProvisioningEnabled" : false,
"isThinProvisioningEnabledValid" : true,
"isTrueSparseFileEnabled" : false,
"isTrueSparseFileEnabledValid" : true,
"isUnlimitedExpansion" : false,
"isWORM" : false,
"label" : "xyz-obj-rep-target-new",
"logicalCapacity" : 0,
"logicalFreeCapacity" : 0,
"objectId" : "38363442313232384142423134344143303030303030303030303030303030303a3a3a303a3a3a4f49445f24232140255f56",
"status" : "MOUNTED",
"storagePoolId" : 9676880324761524863,
"usedCapacity" : 39755677696,
"virtualServerId" : 3
}
}
Request example: Get a file system using the HNAS storage file system ID
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v7/storage/filesystems/864B1228ABB144AC0000000000000000
Response example: Get a file system using the HNAS storage file system ID
HTTP/1.1 200 OK
{
"filesystem" :
{
"blockSize" : 32768,
"capacity" : 58518929408,
"expansionLimits" : 107374182400,
"filesystemId" : "864B1228ABB144AC0000000000000000",
"freeCapacity" : 18763317248,
"isDedupeEnabled" : true,
"isDedupeSupported" : true,
"isLogicalCapacityFreeCapacityValid" : true,
"isLogicalCapacityValid" : true,
"isNDMPRecoveryTarget" : false,
"isNonStrictWORM" : false,
"isObjectReplicationTarget" : true,
"isReadCached" : false,
"isReadOnly" : false,
"isSysLocked" : true,
"isThinProvisioningEnabled" : false,
"isThinProvisioningEnabledValid" : true,
"isTrueSparseFileEnabled" : false,
"isTrueSparseFileEnabledValid" : true,
"isUnlimitedExpansion" : false,
"isWORM" : false,
"label" : "xyz-obj-rep-target-new",
"logicalCapacity" : 0,
"logicalFreeCapacity" : 0,
"objectId" : "38363442313232384142423134344143303030303030303030303030303030303a3a3a303a3a3a4f49445f24232140255f56",
"status" : "MOUNTED",
"storagePoolId" : 9676880324761524863,
"usedCapacity" : 39755612160,
"virtualServerId" : 3
}
}