/scalemgmt/v3/filesystems/{filesystem}/filesets/snapshots:batchCreate: POST

Creates one or more fileset snapshots.

Availability

Available on all IBM Storage Scale editions.

Description

The POST /filesystems/{filesystem}/filesets/snapshots:batchCreate request creates one or more fileset snapshots. You can delete the fileset snapshots only by using /scalemgmt/v3/filesystems/{filesystem}/filesets/{fileset}/snapshots/{snapshot_name}: DELETE or /scalemgmt/v3/filesystems/{filesystem}/filesets/snapshots:batchDelete: POST request. The operation attribute for this request is LRO. To run this request, you must have the RBAC permission for the create action on the /scalemgmt/v3/filesystems/{filesystem}/filesets/snapshots:batchCreate resource. For more information, see Fileset-level snapshots.

Request URL

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

where

{filesystem}: Specifies the name of the filesystem.

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.
body	The body of the request that contains the required parameters to be passed on to the IBM Storage Scale system to perform the requested operation.	Required.
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 indicate the LRO job completed. Check the operation response for detailed results.

{
  "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 creates one or more fileset snapshots:

Request data:

curl -X 'POST' 'https://localhost:46443/scalemgmt/v3/filesystems/fs1/filesets/snapshots:batchCreate' \
  -H 'accept: application/json' \
  -n -k
  -H 'Content-Type: application/json' \
  -d '{
  "snapshots": [
    {
      "fileset_name": "fileset1",
      "name": "fileset1_snapshot1"
    },
    {
      "fileset_name": "fileset2",
      "name": "fileset2_snapshot1"
    }
  ]
}'

Response data:

{
  "name": "MToxN2IyN2I5YS04ZGYxLTQ4MzAtYTY1My1kZTZhMTJmZjk3NGU=",
  "metadata": {
    "@type": "type.googleapis.com/generic.v3.LongRunningOperationMetadata",
    "job_id": "MToxN2IyN2I5YS04ZGYxLTQ4MzAtYTY1My1kZTZhMTJmZjk3NGU=",
    "operation_details": {
      "@type": "type.googleapis.com/snapshot.v3.BatchCreateFilesetSnapshotsRequest",
      "filesystem": "fs1",
      "snapshots": [
        {
          "name": "fileset1_snapshot1",
          "fileset_name": "fileset1"
        },
        {
          "name": "fileset2_snapshot1",
          "fileset_name": "fileset2"
        }
      ]
    },
    "status": "DONE",
    "request_time": "2025-04-03T23:29:24.016736241Z",
    "completion_time": "2025-04-03T23:29:24.367743425Z",
    "last_update_time": "2025-04-03T23:29:24.367743425Z",
    "output": "Flushing dirty data for snapshot...",
    "domain_ids": [0]
  },
  "done": true,
  "response": {
    "@type": "type.googleapis.com/snapshot.v3.BatchCreateFilesetSnapshotsResponse",
    "succeeded": [
      {
        "snapshot": {
          "name": "fileset1_snapshot1",
          "fileset_name": "fileset1"
        },
        "error": {
          "message": "Snapshot fileset1:fileset1_snapshot1 created with id 415.",
          "status": "CREATED"
        }
      },
      {
        "snapshot": {
          "name": "fileset2_snapshot1",
          "fileset_name": "fileset2"
        },
        "error": {
          "message": "Snapshot fileset2:fileset2_snapshot1 created with id 416.",
          "status": "CREATED"
        }
      }
    ]
  }
}