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

Lists filesets in an IBM Storage Scale file system.

Availability

Available on all IBM Storage Scale editions.

Description

The GET filesystems/{filesystem}/filesets request lists filesets in an IBM Storage Scale file system. The operation attributes for this request are LRO, fields and pagination operation. To run this request, you must have the RBAC permission for the get action on the /scalemgmt/v3/filesystems/{filesystem}/filesets resource.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v3/filesystems/{filesystem}/filesets
where
{filesystem}
Specifies the name of the file system.

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.
view Specify the view for fileset content. The possible values are long, attributes, full, and basic. The default value is basic. 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.
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.
    {
  "filesets": [
    {
      "alloc_inodes": "string",
      "comment": "string",
      "create_time": "2024-10-28T17:45:58.092Z",
      "data_in_kb": "string",
      "domain_id": 0,
      "fal_status": "FALSTATUS_DEFAULT",
      "free_inodes": "string",
      "fs_name": "string",
      "iam_mode": "IAMMODE_OFF",
      "id": 0,
      "inode_space": 0,
      "inode_space_designation": "string",
      "inode_space_mask": "string",
      "is_inode_space_owner": true,
      "max_inodes": "string",
      "name": "string",
      "parent_id": "string",
      "path": "string",
      "perm_change_flag": "PERMCHANGEFLAG_CHMODANDSETACL",
      "perm_inherit_flag": "PERMINHERITFLAG_INHERIT_ACL_ONLY",
      "prevent_snapshot_restore": true,
      "root_inode": "string",
      "snap_id": 0,
      "status": "FILESETSTATUS_EMPTY",
      "used_inodes": "string"
    }
  ],
  "next_page_token": "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 filesets in the gpfs0 file system:

Request data: 
curl -X 'GET' \
  'https://localhost:46443/scalemgmt/v3/filesystems/gpfs0/filesets?view=BASIC' \
  -H 'accept: application/json' \
  -n -k
Response data: 
{
	"name": "MTo2MDc5OTE4OS1lMDYzLTQwYjQtYWQyMy02YWNiNTI1MmE5MGM=",
	"metadata": {
		"@type": "type.googleapis.com/generic.v3.LongRunningOperationMetadata",
		"job_id": "MTo2MDc5OTE4OS1lMDYzLTQwYjQtYWQyMy02YWNiNTI1MmE5MGM=",
		"operation_details": {
			"@type": "type.googleapis.com/fileset.v3.ListFilesetsRequest",
			"filesystem": "gpfs0",
			"view": "BASIC"
		},
		"status": "DONE",
		"request_time": "2025-04-14T18:38:25.457485750Z",
		"completion_time": "2025-04-14T18:38:25.464839603Z",
		"last_update_time": "2025-04-14T18:38:25.464839603Z",
		"domain_ids": [
			0
		]
	},
	"done": true,
	"response": {
		"@type": "type.googleapis.com/fileset.v3.ListFilesetsResponse",
		"filesets": [
			{
				"name": "root",
				"fs_name": "gpfs0",
				"id": 0,
				"status": "FILESETSTATUS_LINKED",
				"path": "/mnt/gpfs0",
				"domain_id": 0
			},
			{
				"name": "fset1",
				"fs_name": "gpfs0",
				"id": 1,
				"status": "FILESETSTATUS_LINKED",
				"path": "/mnt/gpfs0/fset1",
				"domain_id": 0
			},
			{
				"name": "fset2",
				"fs_name": "gpfs0",
				"id": 2,
				"status": "FILESETSTATUS_LINKED",
				"path": "/mnt/gpfs0/fset2",
				"domain_id": 0
			},
			{
				"name": "fset3",
				"fs_name": "gpfs0",
				"id": 3,
				"status": "FILESETSTATUS_UNLINKED",
				"path": "--",
				"domain_id": 0
			}
		]
	}
}