cephfs

CephFS file management.

get /cephfs/files

List files in a directory.

Arguments
  • diroptionalstring

    -

Definition
get /cephfs/files
Attributes
  • statsobject

    -

    • pathstring

      -

  • entriesarray

    -

Example response
{ "stats": { "path": "string" }, "entries": [ "string" ] }

patch /cephfs/files

Update or rename a file/directory.

Arguments
  • pathoptionalstring

    -

  • bodyoptional

    -

Definition
patch /cephfs/files

get /cephfs/files-with-stats

List files with all stats in a directory.

Arguments
  • diroptionalstring

    -

Definition
get /cephfs/files-with-stats
Attributes
  • statsobject

    -

    • pathstring

      -

  • entriesarray

    -

    • pathstring

      -

    • fullPathstring

      -

    • lastModifiedinteger

      -

    • uidinteger

      -

    • gidinteger

      -

    • sizeinteger

      -

    • modeinteger

      -

    • typestring

      [FILE, DIR, SYMLINK, UNKNOWN]

    • dirBytesinteger

      -

    • dirFilesinteger

      -

    • dirSubdirsinteger

      -

Example response
{ "stats": { "path": "string" }, "entries": [ { "path": "string", "fullPath": "string", "lastModified": 0, "uid": 0, "gid": 0, "size": 0, "mode": 0, "type": "FILE", "dirBytes": 0, "dirFiles": 0, "dirSubdirs": 0 } ] }

post /cephfs/stats

Get stats for a list of files.

Arguments
  • bodyoptional

    Absolute paths of the requested files.

Definition
post /cephfs/stats
Attributes
  • pathstring

    -

Example response
[ { "path": "string" } ]

get /cephfs/layout

Get the pool a file or directory is stored in.

Arguments
  • pathoptionalstring

    -

Definition
get /cephfs/layout
Attributes
  • poolstring

    -

  • namespacestring

    -

Example response
{ "pool": "string", "namespace": "string" }

put /cephfs/layout

Change the pool a file or directory is stored in.

Arguments
  • pathoptionalstring

    -

  • bodyoptional

    -

Definition
put /cephfs/layout

get /cephfs/quota

Get the quota of a directory.

Arguments
  • diroptionalstring

    -

Definition
get /cephfs/quota
Attributes
  • maxBytesinteger

    -

  • maxFilesinteger

    -

Example response
{ "maxBytes": 0, "maxFiles": 0 }

put /cephfs/quota

Set the quota of a directory.

Arguments
  • diroptionalstring

    -

  • bodyoptional

    -

Definition
put /cephfs/quota

get /cephfs/layout/pools

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

Arguments
  • No arguments...

Definition
get /cephfs/layout/pools
Attributes
Example response
[ "string" ]

post /cephfs/create-directory

Create a new directory recursively.

Arguments
  • bodyoptional

    -

Definition
post /cephfs/create-directory

delete /cephfs/delete

Delete files or directories recursively.

Arguments
  • pathoptionalarray

    -

Definition
delete /cephfs/delete
Attributes
  • namestring

    -

  • idinteger

    -

  • statestring

    [WAITING, RUNNING, FINISHED, FAILED, CANCELED]

  • resultobject

    -

  • doneboolean

    -

  • statusCodeinteger

    -

  • startedAtinteger

    -

  • startedBystring

    -

  • objectstring

    -

  • outputstring

    -

Example response
{ "name": "string", "id": 0, "state": "WAITING", "result": {}, "done": true, "statusCode": 0, "startedAt": 0, "startedBy": "string", "object": "string", "output": "string" }

put /cephfs/copy

Copy a file or directory recursively.

Arguments
  • pathoptionalstring

    -

  • dstPathoptionalstring

    -

Definition
put /cephfs/copy
Attributes
  • namestring

    -

  • idinteger

    -

  • statestring

    [WAITING, RUNNING, FINISHED, FAILED, CANCELED]

  • resultobject

    -

  • doneboolean

    -

  • statusCodeinteger

    -

  • startedAtinteger

    -

  • startedBystring

    -

  • objectstring

    -

  • outputstring

    -

Example response
{ "name": "string", "id": 0, "state": "WAITING", "result": {}, "done": true, "statusCode": 0, "startedAt": 0, "startedBy": "string", "object": "string", "output": "string" }

put /cephfs/move

Rename a file or directory.

Arguments
  • pathoptionalstring

    -

  • dstPathoptionalstring

    -

Definition
put /cephfs/move

get /cephfs/download

Download a file.

Arguments
  • pathoptionalstring

    -

Definition
get /cephfs/download
Attributes
  • fileNamestring

    -

  • urlstring

    -

  • fileContentsstring

    -

Example response
{ "fileName": "string", "url": "string", "fileContents": "string" }

put /cephfs/upload

Upload a file.

Arguments
  • fileoptionalfile

    -

  • pathoptionalstring

    -

Definition
put /cephfs/upload