cephfs
CephFS file management.
put /cephfs/copy
Copy a file or directory recursively.
Parameters
path string query
dstPath string query
Responses
default response
default response
object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
Examples
No request body required
put /cephfs/move
Rename a file or directory.
Parameters
path string query
dstPath string query
Examples
No request body required
get /cephfs/files
List files in a directory.
Parameters
dir string query
Responses
default response
default response
object
Examples
No request body required
patch /cephfs/files
Update or rename a file/directory.
Parameters
path string query
body object
Examples
Request Body
{
"gid": 42,
"uid": 42,
"mode": 42,
"absolutePath": "string"
}get /cephfs/quota
Get the quota of a directory.
Parameters
dir string query
Responses
default response
default response
object
Examples
No request body required
put /cephfs/quota
Set the quota of a directory.
Parameters
dir string query
body object
Examples
Request Body
{
"maxBytes": 42,
"maxFiles": 42
}post /cephfs/stats
Get stats for a list of files.
Parameters
body array
Absolute paths of the requested files. (Array of string items)
Responses
default response
default response
array
Array of CephFsResponse objects
Examples
Request Body
[
"string"
]delete /cephfs/delete
Delete files or directories recursively.
Parameters
path array query
Array of string items
deleteSnapshots boolean query
Responses
default response
default response
object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
Examples
No request body required
get /cephfs/layout
Get the pool a file or directory is stored in.
Parameters
path string query
Responses
default response
default response
object
Examples
No request body required
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
Examples
Request Body
{
"pool": "string",
"namespace": "string"
}put /cephfs/upload
Upload a file.
Parameters
body object
Examples
Request Body
{
"file": {},
"path": "string"
}get /cephfs/clients
List all currently connected CephFS clients.
Parameters
pagination object query
Pagination request. When supplied, the result will be filtered, sorted and limited according to this request object.
Responses
default response
default response
oneOf A response that can be either paginated or a raw list (depending on the presence of the pagination query parameter).
object
A paginated result.
Examples
No request body required
get /cephfs/download
Download a file.
Parameters
path string query
Responses
default response
default response
object
Examples
No request body required
get /cephfs/layout/pools
Get pools that are eligible as data storage location in the layout API.
Responses
default response
default response
array
Array of string items
Examples
No request body required
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 (Array of integer items)
Examples
No request body required
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 object query
Pagination request. When supplied, the result will be filtered, sorted and limited according to this request object.
Responses
default response
default response
object
A paginated result.
Examples
No request body required
post /cephfs/create-directory
Create a new directory recursively.
Parameters
body object
Examples
Request Body
{
"dir": "string",
"pool": "string",
"namespace": "string"
}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
default response
default response
object
Examples
No request body required