ceph-pools

Manage ceph pools.

GET /pools

Parameters

No parameters...

Endpoint

curl -X GET http://mgmt-node:8080/api/pools

Response 200

name
string
optional
-
erasureCoding
boolean
optional
-
description
string
optional
-
poolId
integer
optional
-
pgNum
integer
optional
-
pgpNum
integer
optional
-
minSize
integer
optional
-
size
integer
optional
-
dataChunks
integer
optional
-
parityChunks
integer
optional
-
quotaMaxBytes
integer
optional
-
quotaMaxObjects
integer
optional
-
crushRule
integer
optional
-
stats
object
optional
-
application
string
optional
Application using the pool, default ceph applications are "rbd", "cephfs", and "rgw".
erasureCodingOverwriteSupportMissing
boolean
optional
Indicates whether this pool is missing the ec_overwrites flag.
fastRead
boolean
optional
Enables parallel reading of all k+m shards for erasure coded pools.
unprotectedUntil
number
optional
Duration in seconds.
mirrorInfo
array
optional
List of rbd mirror info for each namespace in the pool, including the pool itself (with namespace set to null). Only available if the pool has the "rbd" application.

Example response

[
  {
    "name": "string",
    "erasureCoding": true,
    "description": "string",
    "poolId": 0,
    "pgNum": 0,
    "pgpNum": 0,
    "minSize": 0,
    "size": 0,
    "dataChunks": 0,
    "parityChunks": 0,
    "quotaMaxBytes": 0,
    "quotaMaxObjects": 0,
    "crushRule": 0,
    "stats": {
      "bytes": 0,
      "objects": 0,
      "readIops": 0,
      "writeIops": 0,
      "readBytesPerSec": 0,
      "writeBytesPerSec": 0
    },
    "application": "string",
    "erasureCodingOverwriteSupportMissing": true,
    "fastRead": true,
    "unprotectedUntil": 0,
    "mirrorInfo": [
      {
        "namespace": "string",
        "poolMirrorMode": "disabled",
        "siteName": "string",
        "peers": [
          {
            "id": "string",
            "siteName": "string",
            "clientName": "string",
            "direction": "rx_tx"
          }
        ],
        "statusHealth": "string",
        "statusStates": {}
      }
    ]
  }
]

POST /pools

Parameters

body
object
optional
-

Endpoint

curl -X POST http://mgmt-node:8080/api/pools

Example body

{
  "name": "string",
  "description": "string",
  "pgNum": 0,
  "minSize": 0,
  "size": 0,
  "erasureCoding": true,
  "dataChunks": 0,
  "parityChunks": 0,
  "quotaMaxBytes": 0,
  "quotaMaxObjects": 0,
  "crushRule": 0,
  "unprotect": true,
  "application": "string",
  "fastRead": true,
  "compression": {
    "algorithm": "LZ4",
    "mode": "None",
    "requiredRatio": 0,
    "minBlobSize": 0,
    "maxBlobSize": 0
  }
}

DELETE /pools/{name}

Parameters

name
string
path
-
body
object
optional
-

Endpoint

curl -X DELETE http://mgmt-node:8080/api/pools/{name}

Example body

{
  "name": "string",
  "poolId": 0,
  "thisWillDeleteData": "string"
}

PATCH /pools/{name}

Parameters

name
string
path
-
body
object
optional
-

Endpoint

curl -X PATCH http://mgmt-node:8080/api/pools/{name}

Example body

{
  "name": "string",
  "description": "string",
  "pgNum": 0,
  "minSize": 0,
  "size": 0,
  "erasureCoding": true,
  "dataChunks": 0,
  "parityChunks": 0,
  "quotaMaxBytes": 0,
  "quotaMaxObjects": 0,
  "crushRule": 0,
  "unprotect": true,
  "application": "string",
  "fastRead": true,
  "compression": {
    "algorithm": "LZ4",
    "mode": "None",
    "requiredRatio": 0,
    "minBlobSize": 0,
    "maxBlobSize": 0
  }
}

GET /pools/{name}/compression

Parameters

name
string
path
-

Endpoint

curl -X GET http://mgmt-node:8080/api/pools/{name}/compression

Response 200

algorithm
string
optional
[LZ4, Snappy, Zlib, Zstd, None]
mode
string
optional
[None, Passive, Aggressive, Force]
requiredRatio
number
optional
-
minBlobSize
integer
optional
-
maxBlobSize
integer
optional
-

Example response

{
  "algorithm": "LZ4",
  "mode": "None",
  "requiredRatio": 0,
  "minBlobSize": 0,
  "maxBlobSize": 0
}

POST /pools/{name}/enable-ec-overwrites

Parameters

name
string
path
-

Endpoint

curl -X POST http://mgmt-node:8080/api/pools/{name}/enable-ec-overwrites

POST /pools/{name}/delete

Parameters

name
string
path
-
body
object
optional
-

Endpoint

curl -X POST http://mgmt-node:8080/api/pools/{name}/delete

Example body

{
  "name": "string",
  "poolId": 0,
  "thisWillDeleteData": "string"
}

GET /pools/{name}/details

Parameters

name
string
path
-

Endpoint

curl -X GET http://mgmt-node:8080/api/pools/{name}/details

Response 200

Example response

{}

POST /pools/{name}/scrub

Parameters

name
string
path
-

Endpoint

curl -X POST http://mgmt-node:8080/api/pools/{name}/scrub

POST /pools/{name}/deep-scrub

Parameters

name
string
path
-

Endpoint

curl -X POST http://mgmt-node:8080/api/pools/{name}/deep-scrub