rbds
Manage RBD images in pools.
get /rbds
List all RBD details in all pools
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
object
A paginated result.
Examples
No request body required
get /rbds/rbd-infos
Get RBD details (size, features, parent, data-pool) for a list of images.
Parameters
image array query
Images to query, syntax is pool/image or pool/namespace/image. (Array of string items)
Responses
default response
default response
object
Examples
No request body required
get /rbds/rbd-names
List all RBD names in all pools
Responses
default response
default response
array
Array of RbdNameResponse objects - An RBD name including pool and namespace.
Examples
No request body required
get /rbds/rbd-pools
List all RBD pools and namespaces
Responses
default response
default response
array
Array of RbdPoolInfo objects - Contains basic information on an RBD pool with namespace.
Examples
No request body required
get /rbds/used-size
Returns RBD pool/namespace/image used size
Parameters
pool string query
The pool to query (required).
namespace string query
The namespace to query. If omitted or set to null, the default namespace will be used.
rbd string query
The rbd to query. If omitted or set to null,the size of the entire namespace will be returned, otherwise only the size of this rbd.
Responses
default response
default response
object
Examples
No request body required
get /pools/{pool}/rbds
List all RBDs including their details in a pool
Parameters
pool string path Required
The pool to operate on
limit integer query
Limit number of results returned (max 100)
offset integer query
Offset for pagination, default = 0
order enum query
ASCDESC
Order returned images alphabetically
namespace string query
The namespace to operate on, optional, default is the default namespace. Ignored when pagination is used.
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
Examples
No request body required
post /pools/{pool}/rbds
Create a new RBD
Parameters
pool string path Required
The pool to operate on
body object
Details of an RBD image that is to be created
Examples
Request Body
{
"name": "string",
"size": 42,
"features": [
"LAYERING"
],
"namespace": "string",
"erasureCodedPool": "string"
}get /pools/{pool}/rbds/{rbd}
Get details of a specific RBD image (not cached)
Parameters
pool string path Required
The pool to operate on
rbd string path Required
namespace string query
The namespace to operate on, optional, default is the default namespace
Responses
default response
default response
object
Examples
No request body required
patch /pools/{pool}/rbds/{rbd}
Change properties of an existing RBD image.
Parameters
pool string path Required
The pool to operate on
rbd string path Required
The RBD image to operate on
namespace string query
The namespace to operate on, optional, default is the default namespace
body object
Details for a RBD update request
Examples
Request Body
{
"name": "string",
"size": 42,
"features": [
"LAYERING"
]
}delete /pools/{pool}/rbds/{rbd}
Delete an existing RBD image
Parameters
pool string path Required
The pool to operate on
rbd string path Required
Name of the RBD to delete
namespace string query
The namespace to operate on, optional, default is the default namespace
body object
Details for an RBD deletion request
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
Request Body
{
"rbd": "string",
"pool": "string",
"namespace": "string",
"thisWillDeleteData": "string"
}post /pools/{pool}/cache-update
Force update the cache for RBD images for a pool and optional namespace.
Parameters
pool string path Required
The pool to operate on
namespace string query
The namespace to operate on, optional, default is the default namespace
Examples
No request body required
get /pools/{pool}/rbd-namespaces
List all existing RBD namespaces
Parameters
pool string path Required
The pool to operate on
Responses
default response
default response
array
Array of RbdNamespace objects
Examples
No request body required
post /pools/{pool}/cache-update-all
Force update the cache for RBD images for pool including all namespaces.
Parameters
pool string path Required
The pool to operate on (including all of its namespaces)
Examples
No request body required
post /pools/{pool}/rbds/{rbd}/flatten
Flatten a clone, making it independent of its parent. Flattening happens in the background and may take hours to complete.
Parameters
pool string path Required
The pool to operate on
rbd string path Required
The RBD image to operate on
namespace string query
The namespace to operate on, optional, default is the default namespace
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
post /pools/{pool}/rbds/{rbd}/cache-update
Force update the cache for RBD images for a single RBD image.
Parameters
pool string path Required
The pool to operate on
rbd string path Required
The RBD image to operate on
namespace string query
The namespace to operate on, optional, default is the default namespace
Examples
No request body required
put /pools/{pool}/rbd-namespaces/{namespace}
Create a new RBD namespace
Parameters
pool string path Required
The pool to operate on
namespace string path Required
The name of the new namespace
Examples
No request body required
delete /pools/{pool}/rbd-namespaces/{namespace}
Delete a RBD namespace
Parameters
pool string path Required
The pool to operate on
namespace string path Required
The name of the new namespace
Examples
No request body required
put /pools/{pool}/rbds/{rbd}/snapshots/{snap}
Create a new snapshot of an image.
Parameters
pool string path Required
The pool to operate on
rbd string path Required
The RBD image name to snapshot
snap string path Required
Name of the new snapshot
namespace string query
The namespace to operate on, optional, default is the default namespace
Examples
No request body required
patch /pools/{pool}/rbds/{rbd}/snapshots/{snap}
Update an existing snapshot of an image.
Parameters
pool string path Required
The pool to operate on
rbd string path Required
The RBD image name to update
snap string path Required
The snapshot name to update
namespace string query
The namespace to operate on, optional, default is the default namespace
body object
Details for an snapshot update request
Examples
Request Body
{
"name": "string",
"protect": true
}delete /pools/{pool}/rbds/{rbd}/snapshots/{snap}
Delete a snapshot of an image.
Parameters
pool string path Required
The pool to operate on
rbd string path Required
The RBD image name to operate on
snap string path Required
The snapshot name to delete
namespace string query
The namespace to operate on, optional, default is the default namespace
Examples
No request body required
post /pools/{pool}/rbds/{rbd}/snapshots/{snap}/clone
Create a clone of a snapshot on an existing image.
Parameters
pool string path Required
The pool to operate on
rbd string path Required
The RBD image to clone
snap string path Required
The snapshot to clone
namespace string query
The namespace to operate on, optional, default is the default namespace
body object
Details for a clone creation request
Examples
Request Body
{
"name": "string",
"pool": "string",
"namespace": "string"
}