Filesystems/{filesystemName}/filesets/{filesetName}/snapshots/latest: GET

Gets information about the latest snapshot of the specified fileset.

Availability

Available on all IBM Storage Scale editions.

Description

The GET filesystems/{filesystemName}/filesets/{filesetName}/snapshots/latest request gets information about the latest snapshot of the specified fileset.

Request URL

https://<IP or host name of API server>:<port>/scalemgmt/v2/filsystems/filesystemname/filesets/filesetName/snapshots/latest
where:
filesystem/filesystemName
Specifies the name of the file system to which the filesets belong. Required.
filesets/filesetName
Specifies the fileset of which the snapshot is taken. Required.
snapshots
Specifies snapshot as the resource of this GET call. Required.

Request headers

Accept: application/json

Request parameters

The following parameters can be used in the request URL to customize the request:
Table 1. List of parameters
Parameter name Description and applicable keywords Required/optional
filesystemName The file system name. You can also use keywords such as :all:, :all_local:, or :all_remote: Required.
filesetName The fileset name. This is the path of the fileset. Required.

Request data

No request data.

Response data

{  
   "status": {
      "code":ReturnCode,
      "message":"ReturnMessage"
   },
   snapshots: [
      {
            "snapshotName":"Snapshot"
            "filesystemName":"Device",
            "filesetName":"Fileset",
            "oid":"ID",
            "snapID":"ID",
            "status":"Status"
            "created":"DateTime",
            "quotas":"Quotas",
            "snapType":"Type",
            "expirationTime":"Date and Time"
      }
   ]
}
"status":
Return status.
"message": "ReturnMessage",
The return message.
"code": ReturnCode
The return code.
"paging"
The URL to retrieve the next page. Paging is enabled when more than 1000 objects are returned by the query.
"snapshotName":"Snapshot"
The snapshot name.
"filesystemName":"Device"
The file system that is the target of the snapshot.
"filesetName":"Fileset"
For a fileset snapshot, the fileset that is a target of the snapshot.
"oid":"ID"
Internal identifier that is used for paging.
"snapID":"ID"
The snapshot ID.
"status":"Status"
The snapshot status.
"created":"DateTime"
The date and time when the snapshot was created.
"quotas":"Quotas"
Any quotas that are applied to the fileset.
"snapType":"Type"
The AFM type of the snapshot, including "afm_snap", "afm_recovery", "afm_failover", "afm_rpo", "afm_baserpo", and "Invalid".
"expirationTime":"Date and Time"
The date and time after which the snapshot is deleted.

Examples

The following example gets information about the recent snapshot for the fileset root in file system cesSharedRoot.

Request data: 
curl -k -u admin:admin001 -X GET --header 'accept:application/json' 
'https://198.51.100.1:443/scalemgmt/v2/filesystems/cesSharedRoot/filesets/root/snapshots/latest'
Response data:
Note: In the JSON data that is returned, the return code indicates whether the command is successful. The response code 200 indicates that the command successfully retrieved the information. Error code 400 represents an invalid request and 500 represents internal server error. 
{
  "status": {
    "code": "200",
    "message": "..."
  },
  "snapshots": [
    {
        "snapshotName": ""@GMT-2021.12.20-18.47.14",
        "filesystemName": "cesSharedRoot",
        "filesetName": "root",
        "oid": "2",
        "snapID": "2",
        "status": "Valid",
        "created": "2021-12-20 13:47:16,000",
        "quotas": "",
        "snapType": ""
        "expirationTime": "2202-01-01-09:10"
    }
  ]
}