Filesystems/{filesystemName}/directory/snapDir: GET

Gets detailed information on the special subdirectories that are connected to snapshots belonging to the specified file system.

Availability

Available on all IBM Storage Scale editions.

Description

The GET filesystems/{filesystemName}/directory/snapdir request gets the information on the special subdirectories that are connected to snapshots belonging to the specified file system. For more information about the fields in the data structures that are returned, see the topics mmsnapdir command.

Request URL

https://management API host:port/scalemgmt/v2/filesystems/filesystemName/directory/snapDir
where:
filesystems/filesystemName
Specifies the name of the file system to which the snapshot belongs. Required.
directory/snapDir
The directory path.

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 request parameters
Parameter name Description and applicable keywords Required/optional
filesystemName The file system name. Required.

Request data

No request data.

Response data

{
   "status": {
      "code":ReturnCode",
      "message":"ReturnMessage"
   },
   "paging": {
    "next": "string",
    "fields": "string",
    "filter": "string",
    "baseUrl": "string",
    "lastId": Number
  },
  "snapdir": [
    {
      "snapDir": "string",
      "type": "string",
      "globalType": "string",
      "globalSnapDir": "string"
    }
  ]
}
"jobs":
An array of elements that describe jobs. Each element describes one job.
"status":
Return status.
"message": "ReturnMessage",
The return message.
"code": ReturnCode
The return code.
"Paging"
"next":"URL"
The URL that is used to retrieve the next page.
"fields":"String"
The fields used in the original request.
"filter":"Request filters"
The filter used in the original request.
"baseURL":"URL"
The URL of the request without any parameters.
"lastId":ID
The id of the last element that can be used to retrieve the next elements.
"snapDir":"Name"
The name of the snapdir.
"type:"Snapdir type"
The type of snapdir.
globalType":"Type"
The type of global snapshot.
"globalSnapDir":"Snapdir Name"
The name of the global snapshot sub directory.

Examples

The following example shows how to get information on a directory in the file system FS1.

Request data: 
curl -k -u admin:admin001 -X GET --header 'accept:application/json'
'https://198.51.100.1:443/scalemgmt/v2/filesystems/FS1/directory/snapDir'
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": "..."
  },
  "paging": {
    "next": "https://localhost:443/scalemgmt/v2/filesystems/gpfs0/filesets?lastId=10001",
    "fields": "period,restrict,sensorName",
    "filter": "usedInodes>100,maxInodes>1024",
    "baseUrl": "/scalemgmt/v2/perfmon/sensor/config",
    "lastId": 10001
  },
  "snapdir": [
    {
      "snapDir": "string",
      "type": "string",
      "globalType": "string",
      "globalSnapDir": "string"
    }
  ]
}