rbds

Manage RBD images in pools.
get /rbds

List all RBD details in all pools

Parameters
pagination string query
Responses
200 successful operation
PaginationResponseRbdImageResponse object
A paginated result.
{
  "data": [
    {
      "name": "string",
      "pool": "string",
      "size": 0,
      "hints": [
        {
          "message": "string",
          "severity": "INFO"
        }
      ],
      "snaps": [
        {
          "id": 0,
          "name": "string",
          "protect": true
        }
      ],
      "parent": {
        "pool": "string",
        "image": "string",
        "snapshot": "string"
      },
      "features": [
        "LAYERING"
      ],
      "namespace": "string",
      "mirrorInfo": {
        "state": "string",
        "primary": true,
        "globalId": "string",
        "peerSites": [
          "string"
        ],
        "daemonHost": "string",
        "lastUpdate": "string",
        "description": "string",
        "mirrorState": "disabled",
        "imageMirrorMode": "disabled"
      },
      "withDetails": true,
      "sizeFormatted": "string",
      "poolMirrorMode": "disabled",
      "erasureCodedPool": "string"
    }
  ],
  "after": 0,
  "limit": 0,
  "total": 0
}
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.
string
Responses
200 successful operation
object 
{
  "additionalProp1": {
    "name": "string",
    "pool": "string",
    "size": 0,
    "hints": [
      {
        "message": "string",
        "severity": "INFO"
      }
    ],
    "snaps": [
      {
        "id": 0,
        "name": "string",
        "protect": true
      }
    ],
    "parent": {
      "pool": "string",
      "image": "string",
      "snapshot": "string"
    },
    "features": [
      "LAYERING"
    ],
    "namespace": "string",
    "mirrorInfo": {
      "state": "string",
      "primary": true,
      "globalId": "string",
      "peerSites": [
        "string"
      ],
      "daemonHost": "string",
      "lastUpdate": "string",
      "description": "string",
      "mirrorState": "disabled",
      "imageMirrorMode": "disabled"
    },
    "withDetails": true,
    "sizeFormatted": "string",
    "poolMirrorMode": "disabled",
    "erasureCodedPool": "string"
  },
  "additionalProp2": {
    "name": "string",
    "pool": "string",
    "size": 0,
    "hints": [
      {
        "message": "string",
        "severity": "INFO"
      }
    ],
    "snaps": [
      {
        "id": 0,
        "name": "string",
        "protect": true
      }
    ],
    "parent": {
      "pool": "string",
      "image": "string",
      "snapshot": "string"
    },
    "features": [
      "LAYERING"
    ],
    "namespace": "string",
    "mirrorInfo": {
      "state": "string",
      "primary": true,
      "globalId": "string",
      "peerSites": [
        "string"
      ],
      "daemonHost": "string",
      "lastUpdate": "string",
      "description": "string",
      "mirrorState": "disabled",
      "imageMirrorMode": "disabled"
    },
    "withDetails": true,
    "sizeFormatted": "string",
    "poolMirrorMode": "disabled",
    "erasureCodedPool": "string"
  },
  "additionalProp3": {
    "name": "string",
    "pool": "string",
    "size": 0,
    "hints": [
      {
        "message": "string",
        "severity": "INFO"
      }
    ],
    "snaps": [
      {
        "id": 0,
        "name": "string",
        "protect": true
      }
    ],
    "parent": {
      "pool": "string",
      "image": "string",
      "snapshot": "string"
    },
    "features": [
      "LAYERING"
    ],
    "namespace": "string",
    "mirrorInfo": {
      "state": "string",
      "primary": true,
      "globalId": "string",
      "peerSites": [
        "string"
      ],
      "daemonHost": "string",
      "lastUpdate": "string",
      "description": "string",
      "mirrorState": "disabled",
      "imageMirrorMode": "disabled"
    },
    "withDetails": true,
    "sizeFormatted": "string",
    "poolMirrorMode": "disabled",
    "erasureCodedPool": "string"
  }
}
get /rbds/rbd-names

List all RBD names in all pools

Responses
200 successful operation
RbdNameResponse array
RbdNameResponse object
An RBD name including pool and namespace.
[
  {
    "rbd": "string",
    "pool": "string",
    "namespace": "string"
  }
]
get /rbds/rbd-pools

List all RBD pools and namespaces

Responses
200 successful operation
RbdPoolInfo array
RbdPoolInfo object
Contains basic information on an RBD pool with namespace.
[
  {
    "ec": true,
    "pool": "string",
    "hints": [
      {
        "message": "string",
        "severity": "INFO"
      }
    ],
    "active": true,
    "namespace": "string"
  }
]
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
200 successful operation
RbdUsedSizeResponse object 
{
  "rbds": [
    {
      "name": "string",
      "snapshot": "string",
      "usedSize": 0,
      "provisionedSize": 0
    }
  ],
  "usedSize": 0,
  "provisionedSize": 0
}
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
Order returned images alphabetically
ASC, DESC
namespace string query
The namespace to operate on, optional, default is the default namespace. Ignored when pagination is used.
pagination string query
Responses
200 successful operation
object 
{}
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
{
  "name": "string",
  "size": 0,
  "features": [
    "LAYERING"
  ],
  "namespace": "string",
  "erasureCodedPool": "string"
}
Responses
default successful operation
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
200 successful operation
RbdImageResponse object 
{
  "name": "string",
  "pool": "string",
  "size": 0,
  "hints": [
    {
      "message": "string",
      "severity": "INFO"
    }
  ],
  "snaps": [
    {
      "id": 0,
      "name": "string",
      "protect": true
    }
  ],
  "parent": {
    "pool": "string",
    "image": "string",
    "snapshot": "string"
  },
  "features": [
    "LAYERING"
  ],
  "namespace": "string",
  "mirrorInfo": {
    "state": "string",
    "primary": true,
    "globalId": "string",
    "peerSites": [
      "string"
    ],
    "daemonHost": "string",
    "lastUpdate": "string",
    "description": "string",
    "mirrorState": "disabled",
    "imageMirrorMode": "disabled"
  },
  "withDetails": true,
  "sizeFormatted": "string",
  "poolMirrorMode": "disabled",
  "erasureCodedPool": "string"
}
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
{
  "name": "string",
  "size": 0,
  "features": [
    "LAYERING"
  ]
}
Responses
default successful operation
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
{
  "rbd": "string",
  "pool": "string",
  "namespace": "string",
  "thisWillDeleteData": "string"
}
Responses
200 successful operation
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0
}
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
Responses
default successful operation
get /pools/{pool}/rbd-namespaces

List all existing RBD namespaces

Parameters
pool string path Required
The pool to operate on
Responses
200 successful operation
RbdNamespace array
RbdNamespace object 
[
  {
    "name": "string"
  }
]
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)
Responses
default successful operation
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
200 successful operation
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0
}
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
Responses
default successful operation
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
Responses
default successful operation
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
Responses
default successful operation
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
Responses
default successful operation
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
{
  "name": "string",
  "protect": true
}
Responses
default successful operation
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
Responses
default successful operation
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
{
  "name": "string",
  "pool": "string",
  "namespace": "string"
}
Responses
default successful operation