Filesystems/{filesystemName}/filesets/{filesetName}/snapshots: POST

Creates a fileset snapshot.

Availability

Available on all IBM Spectrum Scale™ editions.

Description

The POST filesystems/{filesystemName}/filesets/{filesetName}/snapshots command creates a snapshot of the specified fileset.

Request URL

https://IP of API server:<port>/scalemgmt/v2/filesystems/filesystemName/filesets/fileseName/snapshots

where

filesystems/filesystemName: Specifies the file system to which the fileset belongs. Required.
filesets/filesetName: Specifies the fileset of which the snapshot is taken. Required.
snapshots: Specifies snapshot as the resource of this POST call. Required.

Request headers

Content-Type: application/json
Accept: application/json

Request parameters

The following parameters can be used in the request URL to customize the request:

Table 1. List of request 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.
body	Body of the request that contains the required parameters to be passed on to theIBM Spectrum Scale system to perform the requested operation.	Required.

Request data

{
  "snapshotName": ""
}

"snapshotName":: Name of the snapshot to be created.

Response data

{
    "status": {
      "code":ReturnCode",
      "message":"ReturnMessage"
   },
   jobs: [
      {
         "result":"", 
           { 
             "commands":"String",
             "progress":"String,
             "exitCode":"Exit code",
             "stderr":"Error",
             "stdout":"String",
           },
         "request":" ",
           {
             "type":"{GET | POST | PUT | DELETE}",
             "url":"URL",
             "data":"",
           }
         "jobId":"ID",
         "submitted":"Time",
         "completed":Time",
         "status":"Job status",
         }   
        ],
   }

For more information about the fields in the following data structures, see the links at the end of this topic.

"status":

Return status.

"message": "ReturnMessage",: The return message.
"code": ReturnCode: The return code.

"jobs":

An array of elements that describe jobs. Each element describes one job.

"result"

"commands":"String': Array of commands that are run in this job.
"progress":"String': Progress information for the request.
"exitCode":"Exit code": Exit code of command. Zero is success, nonzero denotes failure.
"stderr":"Error": CLI messages from stderr.
"stdout":"String": CLI messages from stdout.

"request"

"type":"{GET | POST | PUT | DELETE}": HTTP request type.
"url":"URL": The URL through which the job is submitted.
"data":" ": Optional.

"jobId":"ID",: The unique ID of the job.
"submitted":"Time": The time at which the job was submitted.
"completed":Time": The time at which the job was completed.
"status":"RUNNING | COMPLETED | FAILED": Status of the job.

Examples

The following example creates a snapshot snap2 of the fileset myFset1 in file system gpfs0.

Request data:

curl -k -u admin:admin001 -X POST --header 'content-type:application/json' --header 'accept:application/json' 
-d '{ \ 
   "snapshotName": "snap2" \ 
 }' 'https://198.51.100.1:443/scalemgmt/v2/filesystems/gpfs0/filesets/myFset1/snapshots'

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": "..."
  },
  "job": [
    {
      "result": {}
      "request": {
        "type": "POST",
        "url": "/scalemgmt/v2/filesystems/gpfs0/filesets/myFset1/snapshots",
        "data": "{"snapshotName": "snap2"}"
      },
      "jobId": "12345",
      "submitted": "2016-11-14 10.35.56",
      "completed": "2016-11-14 10.35.56",
      "status": "COMPLETED"
    }
  ]
}