Explore a storage pool's contents (operator-only).

GET

/v1/storage-pools/{poolId}/contents

Code sample: Shell / cURL

curl --request GET \
  --url https://stratum.example.com/v1/storage-pools/example/contents \
  --header 'Authorization: Bearer <token>'

• A Stratum cluster endpoint.

The storage explorer. Returns the logical volumes inside the pool (and, once the Ceph/ZFS drivers implement the seam, RBD images / ZFS datasets), each mapped to the Stratum object it backs (volume/image/snapshot) with its project, state, and attachment. Reads the per-node sample the pool poller writes, so it works from any control plane behind the API VIP regardless of which node owns the pool; rows carry sampledAt for stale-node detection. Cedar action storage:DescribeStoragePool.

Authorizations

• bearerAuth

Parameters

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

200

The pool’s contents.

Media typeapplication/json

The storage explorer view of one pool’s contents.

object

poolId

required

string

pool

required

Pool identifier (thin-pool name).

string

nodeId

string

driver

string

Allowed values: lvm-thin ceph-rbd zfs

items

required

Array<object>

One entry inside a pool (an LV) + its Stratum mapping.

object

lvName

required

The LV/image/dataset name.

string

vgName

Owning volume group (lvm-thin).

string

nodeId

Node the entry was sampled on.

string

sizeBytes

required

Virtual size.

integer format: int64

dataPercent

Thin allocation actually consumed (%); 0 when not applicable.

number format: double

kind

required

Classification (inferred from the LV name for lvm-thin).

string

Allowed values: volume image snapshot thin-pool other

mappedTo

The Stratum object an LV backs, resolved from the DB. Absent on an item that maps to no live object (an orphan LV worth cleaning up) or on the thin-pool / other kinds.

object

type

required

string

Allowed values: volume image snapshot

id

required

The object id (identical to the LV name for lvm-thin).

string

name

Display name from the DB.

string

projectId

Owning project (volume/snapshot).

string

state

Object lifecycle state.

string

attachedTo

Instance id for an attached volume.

string

createdAt

LV creation time.

string format: date-time

sampledAt

required

When this row was last sampled on its node. A node that stops answering keeps its last sample with an ageing timestamp; UIs should flag stale rows.

string format: date-time

Example

{
  "driver": "lvm-thin",
  "items": [
    {
      "kind": "volume",
      "mappedTo": {
        "type": "volume"
      }
    }
  ]
}

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