Get file system shares associated with a virtual server
Retrieves file system shares associated with a virtual server.
HTTP request syntax (URI)
GET <base_URI>/v8/storage/virtual-servers/{virtualServerId}/{type}
Parameters
Name | Type | Required | Values | Description |
virtualServerId | URI_PARAM | Y | number | Specifies either the virtual server object ID or the HNAS storage virtual server ID. |
type | URI_PARM | Y | string | Type of the file system share. Possible values are cifs or nfs. |
Return codes
Code | Data | Description |
200 | fileSystemShares | Array of fileSystemShare objects retrieved successfully |
400 | Error Message | Missing or invalid request contents. |
404 | Error Message | Requested resource not found. |
500 | Error message | Error associated with the storage system. |
Any HTTP status code other than 200 indicates that the API did not complete successfully.
Request example 1
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.57.75:8444/v8/storage/virtual-servers/383a3a3a/cifs
Response example 1
HTTP/1.1 200 OK { "fileSystemShares": [ { "filesystemId": "75412709E1CB9AAB0000000000000000", "objectId": "353a3a3a36623833613537382d353439342d313164312d393064302d346265653366616163613362", "name": "user-xyz-test-cifs-01-21-3", "path": "\\mypath-cifs-1", "settings": { "accessConfig": "*", "cacheOption": "MANUAL_CACHING_DOCS", "comment": "xyz comment", "isABEEnabled": false, "isFollowGlobalSymbolicLinks": false, "isFollowSymbolicLinks": false, "isForceFileNameToLowercase": false, "isScanForVirusesEnabled": false, "maxConcurrentUsers": 100, "snapshotOption": "SHOW_AND_ALLOW_ACCESS", "transferToReplicationTargetSetting": "DO_NOT_TRANSFER", "userHomeDirectoryMode": "OFF", "userHomeDirectoryPath": "" }, "shareId": "6b83a578-5494-11d1-90d0-4bee3faaca3b", "virtualServerId": 5 }, { "filesystemId": "75412709E1CB9AAB0000000000000000", "objectId": "353a3a3a36626434336466652d323062382d313164312d393031302d356563303033373534353864", "name": "user-xyz-test-cifs-11-16-1", "path": "\\mypath-cifs-1", "settings": { "accessConfig": "*", "cacheOption": "MANUAL_CACHING_DOCS", "comment": "xyz comment", "isABEEnabled": false, "isFollowGlobalSymbolicLinks": false, "isFollowSymbolicLinks": false, "isForceFileNameToLowercase": false, "isScanForVirusesEnabled": false, "maxConcurrentUsers": 100, "snapshotOption": "SHOW_AND_ALLOW_ACCESS", "transferToReplicationTargetSetting": "DO_NOT_TRANSFER", "userHomeDirectoryMode": "OFF", "userHomeDirectoryPath": "" }, "shareId": "6bd43dfe-20b8-11d1-9010-5ec00375458d", "virtualServerId": 5 } ] }
Request example 2
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.57.75:8444/v8/storage/virtual-servers/383a3a3a/nfs
Response example
HTTP/1.1 200 OK { "filesystemShares": [ { "filesystemId": "75412709E1CB9AAB0000000000000000", "objectId": "353a3a3a66366233396131652d303562362d313164302d393136382d356563303033373534353864", "name": "/xyz*name*with*star", "path": "/xyz-*path", "settings": { "accessConfig": "", "localReadCacheOption": "DISABLED", "snapshotOption": "SHOW_AND_ALLOW_ACCESS", "transferToReplicationTargetSetting": "USE_FS_DEFAULT" }, "virtualServerId": 5 }, { "filesystemId": "75412709E1CB9AAB0000000000000000", "objectId": "353a3a3a65653163393135382d653130322d313164302d396464322d346265653366616163613362", "name": "/xyz-path-test-exp", "path": "/xyz/test/path", "shareId": "91c13a68-54ba-11d1-931a-4bee3faaca3b", "settings": { "accessConfig": "*", "localReadCacheOption": "DISABLED", "snapshotOption": "SHOW_AND_ALLOW_ACCESS", "transferToReplicationTargetSetting": "USE_FS_DEFAULT" }, "virtualServerId": 5 } ] }