Skip to content
StratumStratum Docs

Describe a storage pool (operator-only).

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
poolId
required
string

The stable pool id (pool-…). pools are addressed by a surrogate id, since the same pool name can exist on multiple nodes. The id is in GET /v1/storage-pools.

Responses

Section titled “Responses”

200

Section titled “200”

The pool.

Media typeapplication/json

A storage pool. For lvm-thin this is the install’s VG + thin pool on one node; capacity is refreshed by the 60s poller.

object
id
required

Stable surrogate id (pool-…)..

string
name
required
string
driver
required
string
Allowed values: lvm-thin ceph-rbd
nodeId
string
totalBytes
required
integer format: int64
usedBytes
required
integer format: int64
availableBytes
required
integer format: int64
state
required

missing: the backend no longer has the pool; see stateReason. Volumes cannot be placed in it. The next successful poll restores the real state.

string
Allowed values: healthy degraded full missing
stateReason

Why the pool is missing. Absent otherwise.

string
lastPolledAt
string format: date-time
devicePaths
required

Physical devices (PVs) backing the pool’s VG.

Array<string>
volumeGroup

The LVM volume group the pool lives in (lvm-thin only). The install’s default pool is named after its thin LV but lives in the configured VG, so read the VG from here, never from name. Absent for Ceph and until the pool’s node has polled it..

string

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