/scalemgmt/v3/filesystems/{filesystem}/filesets/{fileset}/snapshots: GET

Lists fileset snapshots in an IBM Storage Scale fileset.

Availability

Available on all IBM Storage Scale editions.

Description

The GET filesystems/{filesystem}/filesets/{fileset}/snapshots request gets information about the fileset snapshots.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v3/filesystems/{filesystem}/filesets/{fileset}/snapshots

where

{filesystem}: Specifies the name of the file system.
{fileset_name}: Specifies the name of the fileset.

Request headers

Accept: application/json

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
filesystem	The name of the file system.	Required.
fileset	The name of the fileset.	Required.
view	The type of view for fileset snapshot content. The possible values are "basic" and "data".	Optional.
page_size	The number of items that need to be returned for the request.	Optional.
page_token	The number that is specified to navigate to the next page in the collection.	Optional.
fast	Enables a faster way of calculating the amount of storage that is used by the snapshot, minimizing the impact on the performance of the system.	Optional.
X-StorageScaleDomain	The domain to be authorized against for the request. The default value is `StorageScaleDomain`.	Optional.

Request data

No request data.

Response data

200: A successful response.

{
  "done": true,
  "error": {
    "details": [
      {
        "@type": "string",
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    ],
    "httpcode": 0,
    "message": "string",
    "status": "CANCELLED"
  },
  "metadata": {
    "@type": "string",
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "name": "string",
  "response": {
    "@type": "string",
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}

202: The request has been accepted for processing, but the processing has not been completed.

{
  "done": true,
  "error": {
    "details": [
      {
        "@type": "string",
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    ],
    "httpcode": 0,
    "message": "string",
    "status": "CANCELLED"
  },
  "metadata": {
    "@type": "string",
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "name": "string",
  "response": {
    "@type": "string",
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}

default: An unexpected error response.

{
  "code": 0,
  "details": [
    {
      "@type": "string",
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  ],
  "message": "string"
}

Examples

The following example lists fileset snapshots:

Request data:

curl -X 'GET' 'https://localhost:46443/scalemgmt/v3/filesystems/fs1/filesets/fileset1/snapshots' -H 'accept: application/json' -k -n

Response data:

{
	"name": "MTplYjMxZmIwOS04YmZmLTRiNDMtODRiMC04OTVlZDk4NDkzNDM=",
	"metadata": {
		"@type": "type.googleapis.com/generic.v3.LongRunningOperationMetadata",
		"job_id": "MTplYjMxZmIwOS04YmZmLTRiNDMtODRiMC04OTVlZDk4NDkzNDM=",
		"operation_details": {
			"@type": "type.googleapis.com/snapshot.v3.ListFilesetSnapshotsRequest",
			"filesystem": "fs1",
			"fileset": "fileset1"
		},
		"status": "DONE",
		"request_time": "2025-04-03T23:32:50.779784322Z",
		"completion_time": "2025-04-03T23:32:50.783955900Z",
		"last_update_time": "2025-04-03T23:32:50.783955900Z",
		"domain_ids": [
			0
		]
	},
	"done": true,
	"response": {
		"@type": "type.googleapis.com/snapshot.v3.ListSnapshotsResponse",
		"snapshots": [
			{
				"name": "snapshot2",
				"id": 402,
				"status": "SNAPSHOTSTATUS_VALID",
				"create_time": "2024-12-05T15:55:59Z",
				"expiration_time": "2024-12-05T15:55:59Z",
				"fileset_name": "fileset1"
			},
			{
				"name": "snapshot3",
				"id": 411,
				"status": "SNAPSHOTSTATUS_VALID",
				"create_time": "2025-03-24T05:30:30Z",
				"expiration_time": "2025-03-24T05:30:30Z",
				"fileset_name": "fileset1"
			},
			{
				"name": "snapshot4",
				"id": 412,
				"status": "SNAPSHOTSTATUS_VALID",
				"create_time": "2025-03-24T05:31:19Z",
				"expiration_time": "2025-03-24T05:31:19Z",
				"fileset_name": "fileset1"
			},
			{
				"name": "fileset1_snapshot1",
				"id": 415,
				"status": "SNAPSHOTSTATUS_VALID",
				"create_time": "2025-04-03T23:29:24Z",
				"expiration_time": "2025-04-03T23:29:24Z",
				"fileset_name": "fileset1"
			}
		]
	}
}