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

Gets details about the fileset snapshot in an IBM Storage Scale fileset for the specified snapshot name.

Availability

Available on all IBM Storage Scale editions.

Description

The GET filesystems/{filesystem}/filesets/{fileset}/snapshots/{snapshot_name} request retrieves information for a fileset snapshot. The operation attribute for this request are LRO and fields. To run this request, you must have the RBAC permission for the get action on the /scalemgmt/v3/filesystems/{filesystem}/filesets/{filesets}/snapshots/{snapshot_name} resource.

Note: For snapshots that are created without the retention period defined, the expiration time is the same as its creation time.

Request URL

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

where

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

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.
snapshot_name	The name of the snapshot.	Required.
view	The type of view for fileset snapshot content. The possible values are "basic" and "data".	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 gets information about the fileset snapshot for a specified snapshot name:

Request data:

curl -X 'GET' 'https://localhost:46443/scalemgmt/v3/filesystems/fs1/filesets/fileset1/snapshots/snapshot1?view=BASIC' \
  -H 'accept: application/json' -n -k

Response data:

{
	"name": "MTphM2ZjOTI0NS0wNjliLTQ3NGQtOTllYy0zMDFjOGI1N2UzYjE=",
	"metadata": {
		"@type": "type.googleapis.com/generic.v3.LongRunningOperationMetadata",
		"job_id": "MTphM2ZjOTI0NS0wNjliLTQ3NGQtOTllYy0zMDFjOGI1N2UzYjE=",
		"operation_details": {
			"@type": "type.googleapis.com/snapshot.v3.GetFilesetSnapshotRequest",
			"filesystem": "fs1",
			"fileset": "fileset1",
			"snapshot_name": "snapshot1",
			"view": "BASIC"
		},
		"status": "DONE",
		"request_time": "2025-04-03T23:59:02.159813536Z",
		"completion_time": "2025-04-03T23:59:02.217047491Z",
		"last_update_time": "2025-04-03T23:59:02.217047491Z",
		"domain_ids": [
			0
		]
	},
	"done": true,
	"response": {
		"@type": "type.googleapis.com/snapshot.v3.Snapshot",
		"name": "snapshot1",
		"id": 417,
		"status": "SNAPSHOTSTATUS_VALID",
		"create_time": "2025-04-03T23:56:47Z",
		"expiration_time": "2025-05-03T23:29:24Z",
		"fileset_name": "fileset1"
	}
}