Skip to content
StratumStratum Docs

Storage class capacity + utilization stats.

GET
/v1/storage-classes/{storageClassName}/stats
Code sample: Shell / cURL
curl --request GET \
  --url https://stratum.example.com/v1/storage-classes/example/stats \
  --header 'Authorization: Bearer <token>'

Reads the latest poll from storage.pools (refreshed every 60s by the pool poller). When the pool hasn’t been polled yet, returns zeros + state healthy rather than 404.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
storageClassName
required
string
/^[a-z][a-z0-9-]{1,38}[a-z0-9]$/

Responses

Section titled “Responses”

200

Section titled “200”

Stats.

Media typeapplication/json
object
storageClass
required
string
pool
required
string
driver
required
string
Allowed values: lvm-thin ceph-rbd
totalBytes
required
integer format: int64
usedBytes
required
integer format: int64
availableBytes
required
integer format: int64
usedPercent
required
number format: double
state
required

The pool’s state; missing when its backend no longer has it.

string
Allowed values: healthy degraded full missing
lastPolledAt
string format: date-time

Example 

{
  "driver": "lvm-thin",
  "state": "healthy"
}

404

Section titled “404”

Resource not found.

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