Retrieves detailed information about file system snapshots associated with a file system on the storage system. A unique identifier value identifies the file system.
HTTP request syntax (URI)
GET <base_URI>/v7/storage/filesystems/{id}/snapshots
Parameters
| Name | Type | Required | Values | Description |
|---|---|---|---|---|
| id | URI_PARAM | Y | string | Specifies either the file system object ID or the HNAS storage file system ID. |
Return codes
| Code | Data | Description |
|---|---|---|
| 200 | snapshot | Storage file system snapshots 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 file system object ID
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v7/storage/filesystems/3836353945344445384532464634454130303030303030303030303030303030/snapshots
Response example: Using the file system object ID
HTTP/1.1 200 OK
{
"snapshots" : [
{
"creationReason" : "SNAPSHOT_CREATED_BY_RULE",
"creationTime" : 1477006200,
"displayName" : "2016-10-20_1630-0700.rickSSRule",
"filesystemId" : "8659E4DE8E2FF4EA0000000000000000",
"objectId" : "38363539453444453845324646344541303030303030303030303030303030303a3a3a323031362d31302d32305f313633302d303730302e7269636b535352756c65",
"state" : "SNAPSHOT_MANAGEMENT_STATE_USABLE"
},
{
"creationReason" : "SNAPSHOT_CREATED_BY_APPLICATION",
"creationTime" : 1459455905,
"displayName" : "snap1-rickProdFS",
"filesystemId" : "8659E4DE8E2FF4EA0000000000000000",
"objectId" : "38363539453444453845324646344541303030303030303030303030303030303a3a3a736e6170312d7269636b50726f644653",
"state" : "SNAPSHOT_MANAGEMENT_STATE_USABLE"
},
{
"creationReason" : "SNAPSHOT_CREATED_MANUALLY",
"creationTime" : 1426638564,
"displayName" : "xyz-test-snapshots-0315",
"filesystemId" : "8659E4DE8E2FF4EA0000000000000000",
"objectId" : "38363539453444453845324646344541303030303030303030303030303030303a3a3a6e69636b2d746573742d736e617073686f74732d30333135",
"state" : "SNAPSHOT_MANAGEMENT_STATE_USABLE"
}
]
}
Request example: 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/8659E4DE8E2FF4EA0000000000000000/snapshots
Response example: Using the HNAS storage file system ID
HTTP/1.1 200 OK
{
"snapshots" : [
{
"creationReason" : "SNAPSHOT_CREATED_BY_RULE",
"creationTime" : 1477006200,
"displayName" : "2016-10-20_1630-0700.rickSSRule",
"filesystemId" : "8659E4DE8E2FF4EA0000000000000000",
"objectId" : "38363539453444453845324646344541303030303030303030303030303030303a3a3a323031362d31302d32305f313633302d303730302e7269636b535352756c65",
"state" : "SNAPSHOT_MANAGEMENT_STATE_USABLE"
},
{
"creationReason" : "SNAPSHOT_CREATED_BY_APPLICATION",
"creationTime" : 1459455905,
"displayName" : "snap1-rickProdFS",
"filesystemId" : "8659E4DE8E2FF4EA0000000000000000",
"objectId" : "38363539453444453845324646344541303030303030303030303030303030303a3a3a736e6170312d7269636b50726f644653",
"state" : "SNAPSHOT_MANAGEMENT_STATE_USABLE"
},
{
"creationReason" : "SNAPSHOT_CREATED_MANUALLY",
"creationTime" : 1426638564,
"displayName" : "xyz-test-snapshots-0315",
"filesystemId" : "8659E4DE8E2FF4EA0000000000000000",
"objectId" : "38363539453444453845324646344541303030303030303030303030303030303a3a3a6e69636b2d746573742d736e617073686f74732d30333135",
"state" : "SNAPSHOT_MANAGEMENT_STATE_USABLE"
}
]
}