# rbds

Manage RBD images in pools.
Set management node URL:

# GET /pools/{pool}/rbds

# Parameters

  • poolstring-
  • limitinteger-
  • offsetinteger-
  • orderstring[ASC, DESC]

# Endpoint

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

# Response 200

  • dataarray-
    • namestring-
    • sizeinteger-
    • featuresarray-
    • snapsarray-
      • idinteger-
      • namestring-
    • parentobject-
      • poolstring-
      • imagestring-
      • snapshotstring-
    • erasureCodedPoolstringStore actual data in a separate erasure-coded pool. The main pool will only store metadata.
  • totalElementsinteger-

# 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

  • poolstring-
  • bodyobject-
    • namestring-
    • sizeinteger-
    • featuresarray-
    • snapsarray-
      • idinteger-
      • namestring-
    • parentobject-
      • poolstring-
      • imagestring-
      • snapshotstring-
    • erasureCodedPoolstringStore 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

  • poolstring-
  • rbdstring-

# Endpoint

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

# Response 200

  • namestring-
  • sizeinteger-
  • featuresarray-
  • snapsarray-
    • idinteger-
    • namestring-
  • parentobject-
    • poolstring-
    • imagestring-
    • snapshotstring-
  • erasureCodedPoolstringStore 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

  • poolstring-
  • rbdstring-
  • bodyobject-
    • poolstring-
    • rbdstring-
    • thisWillDeleteDatastring-

# Endpoint

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

# Example body

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

# Response 200

  • statusCodeinteger-
  • idinteger-
  • startedBystring-
  • startedAtinteger-
  • doneboolean-
  • namestring-
  • statestring[WAITING, RUNNING, FINISHED, FAILED, CANCELED]
  • objectstring-
  • outputstring-

# 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

  • poolstring-
  • rbdstring-
  • bodyobject-
    • namestring-
    • sizeinteger-
    • featuresarray-

# 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

  • poolstring-
  • rbdstring-
  • snapstring-

# Endpoint

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

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

# Parameters

  • poolstring-
  • rbdstring-
  • snapstring-

# Endpoint

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

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

# Parameters

  • poolstring-
  • rbdstring-
  • snapstring-
  • bodyobject-
    • namestring-
    • protectboolean-

# 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

  • poolstring-
  • rbdstring-
  • snapstring-
  • bodyobject-
    • poolstring-
    • namestring-

# 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

  • poolstring-
  • rbdstring-

# Endpoint

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