rbds

Manage RBD images in pools.

GET /pools/{pool}/rbds

Parameters

pool
string
path
The pool to operate on
limit
integer
query
optional
Limit number of results returned
offset
integer
query
optional
Offset for pagination, default = 0
order
string
query
optional
[ASC, DESC]
namespace
string
query
optional
The namespace to operate on, optional, default is the default namespace

Endpoint

curl -X GET http://mgmt-node:8080/api/pools/{pool}/rbds?limit=0&offset=0&order=ASC&namespace=string
                

Response 200

data
array
optional
-
totalElements
integer
optional
-
allIds
array
optional
IDs of all elements that are available, not available in all endpoints

Example response

{
  "data": [
    {
      "name": "string",
      "size": 0,
      "features": [
        "LAYERING"
      ],
      "snaps": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "parent": {
        "pool": "string",
        "image": "string",
        "snapshot": "string"
      },
      "erasureCodedPool": "string",
      "namespace": "string"
    }
  ],
  "totalElements": 0,
  "allIds": [
    {}
  ]
}
                  

POST /pools/{pool}/rbds

Parameters

pool
string
path
The pool to operate on
body
object
optional
Details of an RBD image that exists or is to be created

Endpoint

curl -X POST http://mgmt-node:8080/api/pools/{pool}/rbds
                

Example body

{
  "name": "string",
  "size": 0,
  "features": [
    "LAYERING"
  ],
  "snaps": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "parent": {
    "pool": "string",
    "image": "string",
    "snapshot": "string"
  },
  "erasureCodedPool": "string",
  "namespace": "string"
}
                

GET /pools/{pool}/rbds/{rbd}

Parameters

pool
string
path
The pool to operate on
rbd
string
path
-
namespace
string
query
optional
The namespace to operate on, optional, default is the default namespace

Endpoint

curl -X GET http://mgmt-node:8080/api/pools/{pool}/rbds/{rbd}?namespace=string
                

Response 200

name
string
optional
Name of the RBD
size
integer
optional
Size in bytes
features
array
optional
Enabled RBD features
snaps
array
optional
Snapshots of this image (not for creating images), default = default Ceph features
parent
object
optional
-
erasureCodedPool
string
optional
Store actual data in a separate erasure-coded pool. The main pool will only store metadata.
namespace
string
optional
Namespace if this image is not in the default namespace

Example response

{
  "name": "string",
  "size": 0,
  "features": [
    "LAYERING"
  ],
  "snaps": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "parent": {
    "pool": "string",
    "image": "string",
    "snapshot": "string"
  },
  "erasureCodedPool": "string",
  "namespace": "string"
}
                  

DELETE /pools/{pool}/rbds/{rbd}

Parameters

pool
string
path
The pool to operate on
rbd
string
path
Name of the RBD to delete
namespace
string
query
optional
The namespace to operate on, optional, default is the default namespace
body
object
optional
Details for an RBD deletion request

Endpoint

curl -X DELETE http://mgmt-node:8080/api/pools/{pool}/rbds/{rbd}?namespace=string
                

Example body

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

Response 200

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

Example response

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

PATCH /pools/{pool}/rbds/{rbd}

Parameters

pool
string
path
The pool to operate on
rbd
string
path
The RBD image to operate on
namespace
string
query
optional
The namespace to operate on, optional, default is the default namespace
body
object
optional
Details for a RBD update request

Endpoint

curl -X PATCH http://mgmt-node:8080/api/pools/{pool}/rbds/{rbd}?namespace=string
                

Example body

{
  "name": "string",
  "size": 0,
  "features": [
    "LAYERING"
  ]
}
                

PUT /pools/{pool}/rbds/{rbd}/{snap}

Parameters

pool
string
path
The pool to operate on
rbd
string
path
The RBD image name to snapshot
snap
string
path
Name of the new snapshot
namespace
string
query
optional
The namespace to operate on, optional, default is the default namespace

Endpoint

curl -X PUT http://mgmt-node:8080/api/pools/{pool}/rbds/{rbd}/{snap}?namespace=string
                

DELETE /pools/{pool}/rbds/{rbd}/{snap}

Parameters

pool
string
path
The pool to operate on
rbd
string
path
The RBD image name to operate on
snap
string
path
The snapshot name to delete
namespace
string
query
optional
The namespace to operate on, optional, default is the default namespace

Endpoint

curl -X DELETE http://mgmt-node:8080/api/pools/{pool}/rbds/{rbd}/{snap}?namespace=string
                

PATCH /pools/{pool}/rbds/{rbd}/{snap}

Parameters

pool
string
path
The pool to operate on
rbd
string
path
The RBD image name to update
snap
string
path
The snapshot name to update
namespace
string
query
optional
The namespace to operate on, optional, default is the default namespace
body
object
optional
Details for an snapshot update request

Endpoint

curl -X PATCH http://mgmt-node:8080/api/pools/{pool}/rbds/{rbd}/{snap}?namespace=string
                

Example body

{
  "name": "string",
  "protect": true
}
                

POST /pools/{pool}/rbds/{rbd}/{snap}/clone

Parameters

pool
string
path
The pool to operate on
rbd
string
path
The RBD image to clone
snap
string
path
The snapshot to clone
namespace
string
query
optional
The namespace to operate on, optional, default is the default namespace
body
object
optional
Details for a clone creation request

Endpoint

curl -X POST http://mgmt-node:8080/api/pools/{pool}/rbds/{rbd}/{snap}/clone?namespace=string
                

Example body

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

POST /pools/{pool}/rbds/{rbd}/flatten

Parameters

pool
string
path
The pool to operate on
rbd
string
path
The RBD image to operate on
namespace
string
query
optional
The namespace to operate on, optional, default is the default namespace

Endpoint

curl -X POST http://mgmt-node:8080/api/pools/{pool}/rbds/{rbd}/flatten?namespace=string
                

GET /pools/{pool}/rbd-namespaces

Parameters

pool
string
path
The pool to operate on

Endpoint

curl -X GET http://mgmt-node:8080/api/pools/{pool}/rbd-namespaces
                

Response 200

name
string
optional
-

Example response

[
  {
    "name": "string"
  }
]
                  

PUT /pools/{pool}/rbd-namespaces/{namespace}

Parameters

pool
string
path
The pool to operate on
namespace
string
path
The name of the new namespace

Endpoint

curl -X PUT http://mgmt-node:8080/api/pools/{pool}/rbd-namespaces/{namespace}
                

DELETE /pools/{pool}/rbd-namespaces/{namespace}

Parameters

pool
string
path
The pool to operate on
namespace
string
path
The name of the new namespace

Endpoint

curl -X DELETE http://mgmt-node:8080/api/pools/{pool}/rbd-namespaces/{namespace}
                

GET /rbds/rbd-infos

Parameters

image
array
query
optional
Images to query, syntax is pool/image or pool/namespace/image.

Endpoint

curl -X GET http://mgmt-node:8080/api/rbds/rbd-infos?image=string
                

Response 200

Example response

{}