cephfs

CephFS file management.

GET /cephfs/files

Parameters

dir
string
query
optional
-

Endpoint

curl -X GET http://mgmt-node:8080/api/cephfs/files?dir=string
                

Response 200

stats
object
optional
-
entries
array
optional
-

Example response

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

PATCH /cephfs/files

Parameters

path
string
query
optional
-
body
object
optional
-

Endpoint

curl -X PATCH http://mgmt-node:8080/api/cephfs/files?path=string
                

Example body

{
  "absolutePath": "string",
  "uid": 0,
  "gid": 0,
  "mode": 0
}
                

GET /cephfs/files-with-stats

Parameters

dir
string
query
optional
-

Endpoint

curl -X GET http://mgmt-node:8080/api/cephfs/files-with-stats?dir=string
                

Response 200

stats
object
optional
-
entries
array
optional
-

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

Parameters

body
body
optional
Absolute paths of the requested files.

Endpoint

curl -X POST http://mgmt-node:8080/api/cephfs/stats
                

Example body

[
  "string"
]
                

Response 200

path
string
optional
-

Example response

[
  {
    "path": "string"
  }
]
                  

GET /cephfs/layout

Parameters

path
string
query
optional
-

Endpoint

curl -X GET http://mgmt-node:8080/api/cephfs/layout?path=string
                

Response 200

pool
string
optional
-
namespace
string
optional
-

Example response

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

PUT /cephfs/layout

Parameters

path
string
query
optional
-
body
object
optional
-

Endpoint

curl -X PUT http://mgmt-node:8080/api/cephfs/layout?path=string
                

Example body

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

GET /cephfs/quota

Parameters

dir
string
query
optional
-

Endpoint

curl -X GET http://mgmt-node:8080/api/cephfs/quota?dir=string
                

Response 200

maxBytes
integer
optional
-
maxFiles
integer
optional
-

Example response

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

PUT /cephfs/quota

Parameters

dir
string
query
optional
-
body
object
optional
-

Endpoint

curl -X PUT http://mgmt-node:8080/api/cephfs/quota?dir=string
                

Example body

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

GET /cephfs/layout/pools

Parameters

No parameters...

Endpoint

curl -X GET http://mgmt-node:8080/api/cephfs/layout/pools
                

Response 200

Example response

[
  "string"
]
                  

POST /cephfs/create-directory

Parameters

body
object
optional
-

Endpoint

curl -X POST http://mgmt-node:8080/api/cephfs/create-directory
                

Example body

{
  "dir": "string",
  "pool": "string",
  "namespace": "string"
}
                

DELETE /cephfs/delete

Parameters

path
array
query
optional
-
deleteSnapshots
boolean
query
optional
-

Endpoint

curl -X DELETE http://mgmt-node:8080/api/cephfs/delete?path=string&deleteSnapshots=true
                

Response 200

result
object
optional
-
statusCode
integer
optional
-
id
integer
optional
-
done
boolean
optional
-
startedAt
integer
optional
-
startedBy
string
optional
-
name
string
optional
-
state
string
optional
[WAITING, RUNNING, FINISHED, FAILED, CANCELED]
object
string
optional
-
output
string
optional
-

Example response

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

PUT /cephfs/copy

Parameters

path
string
query
optional
-
dstPath
string
query
optional
-

Endpoint

curl -X PUT http://mgmt-node:8080/api/cephfs/copy?path=string&dstPath=string
                

Response 200

result
object
optional
-
statusCode
integer
optional
-
id
integer
optional
-
done
boolean
optional
-
startedAt
integer
optional
-
startedBy
string
optional
-
name
string
optional
-
state
string
optional
[WAITING, RUNNING, FINISHED, FAILED, CANCELED]
object
string
optional
-
output
string
optional
-

Example response

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

PUT /cephfs/move

Parameters

path
string
query
optional
-
dstPath
string
query
optional
-

Endpoint

curl -X PUT http://mgmt-node:8080/api/cephfs/move?path=string&dstPath=string
                

GET /cephfs/download

Parameters

path
string
query
optional
-

Endpoint

curl -X GET http://mgmt-node:8080/api/cephfs/download?path=string
                

Response 200

fileName
string
optional
-
url
string
optional
-
fileContents
string
optional
-

Example response

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

PUT /cephfs/upload

Parameters

file
file
formData
optional
-
path
string
formData
optional
-

Endpoint

curl -X PUT http://mgmt-node:8080/api/cephfs/upload
                

GET /cephfs/clients

Parameters

No parameters...

Endpoint

curl -X GET http://mgmt-node:8080/api/cephfs/clients
                

Response 200

id
integer
optional
-
numLeases
integer
optional
Number of open files
numCaps
integer
optional
Number of CephFS caps
state
string
optional
Connection state
requestLoadAverage
number
optional
Load caused by this client's requests
ip
string
optional
IP the client is connecting from
cephUser
string
optional
Ceph user name used by this client
hostname
string
optional
Hostname reported by the client
mountpoint
string
optional
Subtree mounted by the client
version
string
optional
Client Ceph or kernel version

Example response

[
  {
    "id": 0,
    "numLeases": 0,
    "numCaps": 0,
    "state": "string",
    "requestLoadAverage": 0,
    "ip": "string",
    "cephUser": "string",
    "hostname": "string",
    "mountpoint": "string",
    "version": "string"
  }
]
                  

POST /cephfs/clients/evict

Parameters

id
array
query
optional
ID of the client to evict

Endpoint

curl -X POST http://mgmt-node:8080/api/cephfs/clients/evict?id=0