Skip to content
StratumStratum Docs

List desired Ceph pools (bootstrap-admin).

GET
/v1/admin/storage/ceph/pools
Code sample: Shell / cURL
curl --request GET \
  --url https://stratum.example.com/v1/admin/storage/ceph/pools \
  --header 'Authorization: Bearer <token>'

The operator’s desired Ceph pools (storage tiers): name, size/min_size, failure domain, pg_num, and optional device class. Install-scope; gates on storage:ListCephPools.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Desired pools.

Media typeapplication/json
object
items
Array<object>

A desired Ceph pool (storage tier). deviceClass, when set, pins the pool to a CRUSH device class (ssd/hdd/nvme).

object
name
required
string
size
required

Replica count (default 3).

integer
minSize
required

Minimum replicas for I/O (default 2).

integer
failureDomain
required

CRUSH failure domain (default host).

string
pgNum

Placement groups; 0 = PG autoscaler.

integer
deviceClass

CRUSH device class to pin to (ssd/hdd/nvme); empty = any.

string
application

RADOS application tag: empty/‘rbd’ (block pools, rbd-initialized) or ‘rgw’ (object-storage pools, not rbd-initialized).

string
maxBytes

Per-pool capacity cap in bytes (a hard write-reject ceiling applied via ceph osd pool set-quota); 0 = unlimited. Counts LOGICAL/STORED bytes (at size=3, 1 TiB logical ≈ 3 TiB raw). In the pool list this reflects the LIVE quota in effect on the cluster.

integer format: int64
managed

True for a Stratum-created + fully-reconciled pool (create + size/crush/application); false for a quota-only view of an auto-created cluster pool (RGW’s default.rgw.buckets.data, cephfs data). Only maxBytes is settable on an unmanaged pool.

boolean
storedBytes

LOGICAL/STORED bytes currently in the pool (from ceph df), so the UI can show a used-vs-quota bar. Present only in the pool list.

integer format: int64
system
required

True for the install’s system pool (volumes): the pool the replicated VM-volume tier and the base images live in, and the one that cannot be deleted. Exactly one pool is the system pool, so clients read it from here instead of hard-coding a name.

boolean
cluster

Present when there is no Ceph cluster to read (not set up, bootstrapping, a failed bootstrap, torn down): the reconciler’s observed state, and the list is then empty (the pool list holds the desired pools). Absent on a live answer. Before Ceph exists these reads answer 200 with it, never 503; 503 means a cluster that exists did not answer.

object
fsid
string
phase
required
string
Allowed values: unconfigured bootstrapping ready degraded error tearing-down
health
string
message
string
reportedAt
string format: date-time
reportedBy

The control plane (node id) that wrote this status.

string
rgwDaemonsRunning

The radosgw daemons the reconciler observed running at its last probe. Absent when not observed (no cluster answered, or the gateway listing failed): unknown, not zero.

integer

Example 

{
  "cluster": {
    "phase": "unconfigured"
  }
}

403

Section titled “403”

Authenticated but not authorized.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
string
instance
string format: uri-reference
requestId
required
string
code
required
string
issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object
code
required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string
statement
required

Index of the statement at fault; -1 for the document as a whole.

integer
>= -1
detail
required
string
action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string
errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object
field
required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string
message
required
string
details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object
key
additional properties
any

Example 

{
  "issues": [
    {
      "code": "ACTION_NOT_APPLICABLE",
      "action": "compute:CreateVpc"
    }
  ]
}