# ceph-pools

Manage ceph pools.
Set management node URL:

# GET /pools

# Parameters

  • No parameters...

# Endpoint

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

# Response 200

  • namestringoptional-
  • erasureCodingbooleanoptional-
  • descriptionstringoptional-
  • poolIdintegeroptional-
  • pgNumintegeroptional-
  • pgpNumintegeroptional-
  • minSizeintegeroptional-
  • sizeintegeroptional-
  • dataChunksintegeroptional-
  • parityChunksintegeroptional-
  • quotaMaxBytesintegeroptional-
  • quotaMaxObjectsintegeroptional-
  • crushRuleintegeroptional-
  • statsobjectoptional-
    • bytesintegeroptional-
    • objectsintegeroptional-
    • readIopsnumberoptional-
    • writeIopsnumberoptional-
    • readBytesPerSecnumberoptional-
    • writeBytesPerSecnumberoptional-
  • applicationstringoptionalApplication using the pool, default ceph applications are "rbd", "cephfs", and "rgw".
  • erasureCodingOverwriteSupportMissingbooleanoptionalIndicates whether this pool is missing the ec_overwrites flag.
  • fastReadbooleanoptionalEnables parallel reading of all k+m shards for erasure coded pools.

# 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": ,
      "writeIops": ,
      "readBytesPerSec": ,
      "writeBytesPerSec": 
    },
    "application": "string",
    "erasureCodingOverwriteSupportMissing": true,
    "fastRead": true
  }
]

# POST /pools

# Parameters

  • bodyobjectoptional-
    • namestringoptional-
    • descriptionstringoptional-
    • pgNumintegeroptional-
    • minSizeintegeroptional-
    • sizeintegeroptional-
    • erasureCodingbooleanoptional-
    • dataChunksintegeroptional-
    • parityChunksintegeroptional-
    • quotaMaxBytesintegeroptional-
    • quotaMaxObjectsintegeroptional-
    • crushRuleintegeroptional-
    • unprotectbooleanoptional-
    • applicationstringoptionalApplication using the pool, default ceph applications are "rbd", "cephfs", and "rgw".
    • fastReadbooleanoptionalEnables parallel reading of all k+m shards for erasure coded pools.

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

# DELETE /pools/{name}

# Parameters

  • namestringpath-
  • bodyobjectoptional-
    • namestringoptional-
    • poolIdintegeroptional-
    • thisWillDeleteDatastringoptional-

# Endpoint

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

# Example body

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

# PATCH /pools/{name}

# Parameters

  • namestringpath-
  • bodyobjectoptional-
    • namestringoptional-
    • descriptionstringoptional-
    • pgNumintegeroptional-
    • minSizeintegeroptional-
    • sizeintegeroptional-
    • erasureCodingbooleanoptional-
    • dataChunksintegeroptional-
    • parityChunksintegeroptional-
    • quotaMaxBytesintegeroptional-
    • quotaMaxObjectsintegeroptional-
    • crushRuleintegeroptional-
    • unprotectbooleanoptional-
    • applicationstringoptionalApplication using the pool, default ceph applications are "rbd", "cephfs", and "rgw".
    • fastReadbooleanoptionalEnables parallel reading of all k+m shards for erasure coded pools.

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

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

Enable the ec_overwrites flag for the pool.

# Parameters

  • namestringpath-

# Endpoint

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

# POST /pools/{name}/delete

# Parameters

  • namestringpath-
  • bodyobjectoptional-
    • namestringoptional-
    • poolIdintegeroptional-
    • thisWillDeleteDatastringoptional-

# 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

  • namestringpath-

# Endpoint

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

# Response 200

# Example response

{}