Skip to content
StratumStratum Docs

List storage classes.

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

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Storage classes.

Media typeapplication/json

Complete: returns every storage class in the catalog.

This list is bounded by the install’s own configuration rather than by tenant activity, so it is not paginated and carries no nextPageToken. A client has the whole set in one response.

object
items
required
Array<object>
object
id
required
string
/^sc-[a-z0-9-]+$/
name
required
string
/^[a-z][a-z0-9-]{1,38}[a-z0-9]$/
displayName
required
string
>= 1 characters <= 100 characters
description
string
driver
required
string
Allowed values: lvm-thin ceph-rbd
pool
required

The class’s pool binding: the cluster-wide RBD pool for ceph-rbd classes, or the per-node pool NAME for lvm-thin classes (the nodes owning a pool of that name are the placement candidates).

string
options
required
object
key
additional properties
string
isDefault
required
boolean
state
required
string
Allowed values: active draining deleted
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
qos

Per-volume I/O limits of a storage class. A new volume that asks for no limit gets the default; one asking for more than the maximum is refused (400). Absent = none. A default may not exceed its maximum.

object
defaultIopsLimit
integer
>= 1
maxIopsLimit
integer
>= 1
defaultThroughputLimitMbps

MB/s (decimal megabytes per second).

integer
>= 1
maxThroughputLimitMbps

MB/s (decimal megabytes per second).

integer
>= 1

Example 

{
  "items": [
    {
      "driver": "lvm-thin",
      "state": "active"
    }
  ]
}