cephfs

CephFS file management.
put /cephfs/copy

Copy a file or directory recursively.

Parameters
path string query
dstPath string query
Responses
200 successful operation
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0
}
put /cephfs/move

Rename a file or directory.

Parameters
path string query
dstPath string query
Responses
default successful operation
get /cephfs/files

List files in a directory.

Parameters
dir string query
Responses
200 successful operation
CephFsDirectoryEntries object 
{
  "stats": {
    "dir": true,
    "gid": 0,
    "uid": 0,
    "mode": 0,
    "path": "string",
    "size": 0,
    "type": "FILE",
    "dirBytes": 0,
    "dirFiles": 0,
    "fullPath": "string",
    "dirSubdirs": 0,
    "symlinkPath": "string",
    "lastModified": 0,
    "modeFormatted": "string",
    "quotaMaxBytes": 0,
    "quotaMaxFiles": 0,
    "sizeFormatted": "string",
    "dirFilesFormatted": "string",
    "quotaMaxBytesFormatted": "string"
  },
  "entries": [
    "string"
  ]
}
patch /cephfs/files

Update or rename a file/directory.

Parameters
path string query
body object 
{
  "gid": 0,
  "uid": 0,
  "mode": 0,
  "absolutePath": "string"
}
Responses
default successful operation
get /cephfs/quota

Get the quota of a directory.

Parameters
dir string query
Responses
200 successful operation
CephFsQuota object 
{
  "maxBytes": 0,
  "maxFiles": 0
}
put /cephfs/quota

Set the quota of a directory.

Parameters
dir string query
body object 
{
  "maxBytes": 0,
  "maxFiles": 0
}
Responses
default successful operation
post /cephfs/stats

Get stats for a list of files.

Parameters
body array
string 
[
  "string"
]
Responses
200 successful operation
CephFsResponse array
CephFsResponse object 
[
  {
    "dir": true,
    "gid": 0,
    "uid": 0,
    "mode": 0,
    "path": "string",
    "size": 0,
    "type": "FILE",
    "dirBytes": 0,
    "dirFiles": 0,
    "fullPath": "string",
    "dirSubdirs": 0,
    "symlinkPath": "string",
    "lastModified": 0,
    "modeFormatted": "string",
    "quotaMaxBytes": 0,
    "quotaMaxFiles": 0,
    "sizeFormatted": "string",
    "dirFilesFormatted": "string",
    "quotaMaxBytesFormatted": "string"
  }
]
delete /cephfs/delete

Delete files or directories recursively.

Parameters
path array query
string
deleteSnapshots boolean query
Responses
200 successful operation
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0
}
get /cephfs/layout

Get the pool a file or directory is stored in.

Parameters
path string query
Responses
200 successful operation
CephFsLayout object 
{
  "pool": "string",
  "namespace": "string"
}
put /cephfs/layout

Change the pool a file or directory is stored in.

Files can only be changed if they are empty. Changing a directory only affects new files and subdirectories.

Parameters
path string query
body object 
{
  "pool": "string",
  "namespace": "string"
}
Responses
default successful operation
put /cephfs/upload

Upload a file.

Parameters
file file formData
path string formData
Responses
default successful operation
get /cephfs/clients

List all currently connected CephFS clients.

Parameters
pagination string query
Responses
200 successful operation
CephfsClientInfo array
CephfsClientInfo object
A Ceph client connected to CephFS, can be either a Kernel or libcephfs client.
[
  {
    "id": 0,
    "ip": "string",
    "state": "string",
    "numCaps": 0,
    "version": "string",
    "cephUser": "string",
    "hostname": "string",
    "numLeases": 0,
    "mountpoint": "string",
    "requestLoadAverage": 0
  }
]
get /cephfs/download

Download a file.

Parameters
path string query
Responses
200 successful operation
DownloadableObject object 
{
  "url": "string",
  "fileName": "string",
  "fileContents": "string"
}
get /cephfs/layout/pools

Get pools that are eligible as data storage location in the layout API.

Responses
200 successful operation
array
string 
[
  "string"
]
post /cephfs/clients/evict

Evict (kick) a connected client, the client can reconnect but must do so explicitly.

Parameters
id array query
ID of the client to evict
integer
Responses
default successful operation
get /cephfs/files-paginated

List files with all stats in a directory.

Avoid calling this too often or on directories with > 10k files.

Parameters
dir string query
pagination string query
Responses
200 successful operation
PaginationResponseCephFsResponse object
A paginated result.
{
  "data": [
    {
      "dir": true,
      "gid": 0,
      "uid": 0,
      "mode": 0,
      "path": "string",
      "size": 0,
      "type": "FILE",
      "dirBytes": 0,
      "dirFiles": 0,
      "fullPath": "string",
      "dirSubdirs": 0,
      "symlinkPath": "string",
      "lastModified": 0,
      "modeFormatted": "string",
      "quotaMaxBytes": 0,
      "quotaMaxFiles": 0,
      "sizeFormatted": "string",
      "dirFilesFormatted": "string",
      "quotaMaxBytesFormatted": "string"
    }
  ],
  "after": 0,
  "limit": 0,
  "total": 0
}
post /cephfs/create-directory

Create a new directory recursively.

Parameters
body object 
{
  "dir": "string",
  "pool": "string",
  "namespace": "string"
}
Responses
default successful operation
get /cephfs/files-with-stats

List files with all stats in a directory.

Avoid calling this too often or on directories with > 10k files.

Parameters
dir string query
Responses
200 successful operation
CephFsDirectoryEntriesWithStats object 
{
  "stats": {
    "dir": true,
    "gid": 0,
    "uid": 0,
    "mode": 0,
    "path": "string",
    "size": 0,
    "type": "FILE",
    "dirBytes": 0,
    "dirFiles": 0,
    "fullPath": "string",
    "dirSubdirs": 0,
    "symlinkPath": "string",
    "lastModified": 0,
    "modeFormatted": "string",
    "quotaMaxBytes": 0,
    "quotaMaxFiles": 0,
    "sizeFormatted": "string",
    "dirFilesFormatted": "string",
    "quotaMaxBytesFormatted": "string"
  },
  "entries": [
    {
      "dir": true,
      "gid": 0,
      "uid": 0,
      "mode": 0,
      "path": "string",
      "size": 0,
      "type": "FILE",
      "dirBytes": 0,
      "dirFiles": 0,
      "fullPath": "string",
      "dirSubdirs": 0,
      "symlinkPath": "string",
      "lastModified": 0,
      "modeFormatted": "string",
      "quotaMaxBytes": 0,
      "quotaMaxFiles": 0,
      "sizeFormatted": "string",
      "dirFilesFormatted": "string",
      "quotaMaxBytesFormatted": "string"
    }
  ]
}