# rbds

Manage RBD images in pools.
Set management node URL:

# GET /pools/{pool}/rbds

# Parameters

  • poolstringpath-
  • limitintegerqueryoptional-
  • offsetintegerqueryoptional-
  • orderstringqueryoptional[ASC, DESC]

# Endpoint

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

# Response 200

  • dataarrayoptional-
    • namestringoptional-
    • sizeintegeroptional-
    • featuresarrayoptional-
    • snapsarrayoptional-
      • idintegeroptional-
      • namestringoptional-
    • parentobjectoptional-
      • poolstringoptional-
      • imagestringoptional-
      • snapshotstringoptional-
    • erasureCodedPoolstringoptionalStore actual data in a separate erasure-coded pool. The main pool will only store metadata.
  • totalElementsintegeroptional-

# Example response

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

# POST /pools/{pool}/rbds

# Parameters

  • poolstringpath-
  • bodyobjectoptional-
    • namestringoptional-
    • sizeintegeroptional-
    • featuresarrayoptional-
    • snapsarrayoptional-
      • idintegeroptional-
      • namestringoptional-
    • parentobjectoptional-
      • poolstringoptional-
      • imagestringoptional-
      • snapshotstringoptional-
    • erasureCodedPoolstringoptionalStore actual data in a separate erasure-coded pool. The main pool will only store metadata.

# 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"
}

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

# Parameters

  • poolstringpath-
  • rbdstringpath-

# Endpoint

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

# Response 200

  • namestringoptional-
  • sizeintegeroptional-
  • featuresarrayoptional-
  • snapsarrayoptional-
    • idintegeroptional-
    • namestringoptional-
  • parentobjectoptional-
    • poolstringoptional-
    • imagestringoptional-
    • snapshotstringoptional-
  • erasureCodedPoolstringoptionalStore actual data in a separate erasure-coded pool. The main pool will only store metadata.

# Example response

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

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

# Parameters

  • poolstringpath-
  • rbdstringpath-
  • bodyobjectoptional-
    • poolstringoptional-
    • rbdstringoptional-
    • thisWillDeleteDatastringoptional-

# Endpoint

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

# Example body

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

# Response 200

  • statusCodeintegeroptional-
  • idintegeroptional-
  • startedBystringoptional-
  • startedAtintegeroptional-
  • donebooleanoptional-
  • namestringoptional-
  • statestringoptional[WAITING, RUNNING, FINISHED, FAILED, CANCELED]
  • objectstringoptional-
  • outputstringoptional-

# Example response

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

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

# Parameters

  • poolstringpath-
  • rbdstringpath-
  • bodyobjectoptional-
    • namestringoptional-
    • sizeintegeroptional-
    • featuresarrayoptional-

# Endpoint

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

# Example body

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

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

# Parameters

  • poolstringpath-
  • rbdstringpath-
  • snapstringpath-

# Endpoint

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

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

# Parameters

  • poolstringpath-
  • rbdstringpath-
  • snapstringpath-

# Endpoint

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

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

# Parameters

  • poolstringpath-
  • rbdstringpath-
  • snapstringpath-
  • bodyobjectoptional-
    • namestringoptional-
    • protectbooleanoptional-

# Endpoint

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

# Example body

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

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

# Parameters

  • poolstringpath-
  • rbdstringpath-
  • snapstringpath-
  • bodyobjectoptional-
    • poolstringoptional-
    • namestringoptional-

# Endpoint

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

# Example body

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

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

# Parameters

  • poolstringpath-
  • rbdstringpath-

# Endpoint

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