Skip to content
StratumStratum Docs

Ceph cluster health roll-up (bootstrap-admin).

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

Cluster health (HEALTH_OK/WARN/ERR + active checks), mon quorum, mgr availability, OSD up/in counts, PG state summary, and raw/used/available usage. Install-scope; gates on storage:GetCephStatus.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Cluster status.

Media typeapplication/json

Ceph cluster-health roll-up.

object
fsid
required
string
health
required

Ceph’s verdict. NONE when there is no Ceph cluster to ask: cluster then says why, and the counts are zero.

string
Allowed values: HEALTH_OK HEALTH_WARN HEALTH_ERR NONE
healthChecks
Array<object>

One active Ceph health check (e.g. OSD_DOWN, MON_DOWN).

object
code
required
string
severity
required

HEALTH_WARN | HEALTH_ERR

string
message
string
count
integer
flags

Operator-set OSDMap flags currently active (noout, noscrub,…).

Array<string>
monCount
required
integer
quorumNames
Array<string>
mgrAvailable
boolean
mgrActive

Active mgr daemon name (empty during a standby swap).

string
mgrStandbys
integer
osdCount
required
integer
osdUp
integer
osdIn
integer
pgCount
integer
pgStates
Array<object>

One placement-group state bucket (e.g. active+clean).

object
state
required
string
count
required
integer
objects
integer format: int64
bytesTotal
integer format: int64
bytesUsed
integer format: int64
bytesAvail
integer format: int64
cluster

Present when there is no Ceph cluster to ask (not set up, bootstrapping, a failed bootstrap, torn down): the reconciler’s observed state. Absent on a live 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 

{
  "health": "HEALTH_OK",
  "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"
    }
  ]
}

503

Section titled “503”

Upstream temporarily unavailable (driver / scheduler / dependency).

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"
    }
  ]
}