ceph-pools

Manage ceph pools.
get /pools

List of all pools.

Parameters
pagination string query
Responses
200 successful operation
CephPoolResponse array
CephPoolResponse object 
[
  {
    "name": "string",
    "size": 0,
    "hints": [
      {
        "message": "string",
        "severity": "INFO"
      }
    ],
    "pgNum": 0,
    "stats": {
      "bytes": 0,
      "objects": 0,
      "readIops": 0,
      "writeIops": 0,
      "bytesFormatted": "string",
      "readBytesPerSec": 0,
      "writeBytesPerSec": 0,
      "readIopsFormatted": 0,
      "writeIopsFormatted": 0,
      "readBytesPerSecFormatted": "string",
      "writeBytesPerSecFormatted": "string"
    },
    "pgpNum": 0,
    "poolId": 0,
    "minSize": 0,
    "fastRead": true,
    "crushRule": 0,
    "dataChunks": 0,
    "redundancy": "string",
    "application": "string",
    "description": "string",
    "parityChunks": 0,
    "erasureCoding": true,
    "quotaMaxBytes": 0,
    "deleteProtected": true,
    "quotaMaxObjects": 0,
    "unprotectedUntil": 0,
    "quotaMaxBytesFormatted": "string",
    "quotaMaxObjectsFormatted": "string",
    "unprotectedUntilFormatted": "string",
    "erasureCodingOverwriteSupportMissing": true
  }
]
post /pools
Parameters
body object 
{
  "name": "string",
  "size": 0,
  "pgNum": 0,
  "minSize": 0,
  "fastRead": true,
  "crushRule": 0,
  "unprotect": true,
  "dataChunks": 0,
  "application": "string",
  "compression": {
    "mode": "None",
    "algorithm": "LZ4",
    "maxBlobSize": 0,
    "minBlobSize": 0,
    "requiredRatio": 0
  },
  "description": "string",
  "parityChunks": 0,
  "erasureCoding": true,
  "quotaMaxBytes": 0,
  "quotaMaxObjects": 0
}
Responses
default successful operation
patch /pools/{name}
Parameters
name string path Required
body object 
{
  "name": "string",
  "size": 0,
  "pgNum": 0,
  "minSize": 0,
  "fastRead": true,
  "crushRule": 0,
  "unprotect": true,
  "dataChunks": 0,
  "application": "string",
  "compression": {
    "mode": "None",
    "algorithm": "LZ4",
    "maxBlobSize": 0,
    "minBlobSize": 0,
    "requiredRatio": 0
  },
  "description": "string",
  "parityChunks": 0,
  "erasureCoding": true,
  "quotaMaxBytes": 0,
  "quotaMaxObjects": 0
}
Responses
default successful operation
delete /pools/{name}
Parameters
name string path Required
body object 
{
  "name": "string",
  "poolId": 0,
  "thisWillDeleteData": "string"
}
Responses
default successful operation
post /pools/{name}/scrub
Parameters
name string path Required
Responses
default successful operation
post /pools/{name}/delete
Parameters
name string path Required
body object 
{
  "name": "string",
  "poolId": 0,
  "thisWillDeleteData": "string"
}
Responses
default successful operation
get /pools/{name}/details
Parameters
name string path Required
Responses
200 successful operation
object
Arbitrary JSON data.
{}
post /pools/{name}/deep-scrub
Parameters
name string path Required
Responses
default successful operation
get /pools/{name}/compression
Parameters
name string path Required
Responses
200 successful operation
PoolCompressionSettings object 
{
  "mode": "None",
  "algorithm": "LZ4",
  "maxBlobSize": 0,
  "minBlobSize": 0,
  "requiredRatio": 0
}
post /pools/{name}/enable-ec-overwrites

Enable the ec_overwrites flag for the pool.

croit tries to enable this when creating the pool, however, this may fail if there are non-Bluestore OSDs. Pools that should have this flag but don't can be identified by the field 'erasureCodingOverwriteSupportMissing'.

Parameters
name string path Required
Responses
default successful operation