# 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

  • namestring-
  • erasureCodingboolean-
  • descriptionstring-
  • poolIdinteger-
  • pgNuminteger-
  • pgpNuminteger-
  • minSizeinteger-
  • sizeinteger-
  • dataChunksinteger-
  • parityChunksinteger-
  • quotaMaxBytesinteger-
  • quotaMaxObjectsinteger-
  • crushRuleinteger-
  • statsobject-
    • bytesinteger-
    • objectsinteger-
    • readIopsnumber-
    • writeIopsnumber-
    • readBytesPerSecnumber-
    • writeBytesPerSecnumber-
  • applicationstringApplication using the pool, default ceph applications are "rbd", "cephfs", and "rgw".
  • erasureCodingOverwriteSupportMissingbooleanIndicates whether this pool is missing the ec_overwrites flag.
  • fastReadbooleanEnables 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

  • bodyobject-
    • namestring-
    • descriptionstring-
    • pgNuminteger-
    • minSizeinteger-
    • sizeinteger-
    • erasureCodingboolean-
    • dataChunksinteger-
    • parityChunksinteger-
    • quotaMaxBytesinteger-
    • quotaMaxObjectsinteger-
    • crushRuleinteger-
    • unprotectboolean-
    • applicationstringApplication using the pool, default ceph applications are "rbd", "cephfs", and "rgw".
    • fastReadbooleanEnables 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

  • namestring-
  • bodyobject-
    • namestring-
    • poolIdinteger-
    • thisWillDeleteDatastring-

# Endpoint

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

# Example body

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

# PATCH /pools/{name}

# Parameters

  • namestring-
  • bodyobject-
    • namestring-
    • descriptionstring-
    • pgNuminteger-
    • minSizeinteger-
    • sizeinteger-
    • erasureCodingboolean-
    • dataChunksinteger-
    • parityChunksinteger-
    • quotaMaxBytesinteger-
    • quotaMaxObjectsinteger-
    • crushRuleinteger-
    • unprotectboolean-
    • applicationstringApplication using the pool, default ceph applications are "rbd", "cephfs", and "rgw".
    • fastReadbooleanEnables 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

  • namestring-

# Endpoint

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

# POST /pools/{name}/delete

# Parameters

  • namestring-
  • bodyobject-
    • namestring-
    • poolIdinteger-
    • thisWillDeleteDatastring-

# 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

  • namestring-

# Endpoint

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

# Response 200

# Example response

{}