Skip to content

Create a storage class.

POST
/v1/storage-classes
Code sample: Shell / cURL
curl --request POST \
--url https://stratum.example.com/v1/storage-classes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "displayName": "example", "description": "example", "driver": "lvm-thin", "pool": "example", "options": { "additionalProperty": "example" }, "isDefault": true, "qos": { "defaultIopsLimit": 1, "maxIopsLimit": 1, "defaultThroughputLimitMbps": 1, "maxThroughputLimitMbps": 1 } }'

Bootstrap-admin only. The driver+pool pair is immutable a new pool means a new class.

stratum-compute is the class the install creates for the OS disk’s pool. A class of that name can only bind that pool (lvm-thin, the install’s configured pool); bound to any other pool it is refused with 400 RESERVED_NAME.

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

The class’s pool binding: a ceph pool from the ceph pool registry for ceph-rbd classes, or the per-node pool NAME for lvm-thin classes.

string
options
object
key
additional properties
string
isDefault
boolean
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

Created.

Media typeapplication/json
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

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

Bad request.

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

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

Conflicting state.

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