Create a volume from an image.
curl --request POST \ --url https://stratum.example.com/v1/projects/example/compute/images/example/actions/create-volume \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "example", "displayName": "example", "description": "example", "sizeBytes": 1, "storageClass": "example", "tags": { "additionalProperty": "example" } }'The canonical “boot a VM from this image” entry point. The new volume shares blocks with the image until divergence (thin-pool CoW), so create is O(ms) regardless of image size.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”object
Optional. When omitted, the new volume inherits the image size. When set, MUST be >= image size and multiple of 1 GiB.
Optional. When omitted, the volume lands in the image’s
storage class. Another class must be able to hold a clone of
the image (same storage driver; for lvm-thin, the same pool):
one of the image’s launchableStorageClasses, or the request is
refused with 409 IMAGE_POOL_MISMATCH.
AWS-shape resource tags. Freeform UTF-8 keys (1-128 bytes, no
leading/trailing whitespace) mapped to freeform UTF-8 values
(0-256 bytes). Max 50 tags per resource. Reserved prefixes
(stratum.dev/, stratum.platform_health., stratum:,
aws:) return 400 RESERVED_NAMESPACE on customer input.
PATCH replaces the whole map..
object
Example generated
{ "name": "example", "displayName": "example", "description": "example", "sizeBytes": 1, "storageClass": "example", "tags": { "additionalProperty": "example" }}Responses
Section titled “Responses”Accepted.
object
Canonical Stratum ARN for this volume, for resource-policy targeting.
. Human-readable cause. Set when state is error (e.g. a
root-volume clone whose base image never staged within the
cold-start deadline: “image base unavailable”), and while
deleting when the delete is BLOCKED: the volume still
has snapshots (waiting for snapshots snap-… to be deleted), the
backing device is still held open, or the backend returned a
transient error. A blocked delete is not a failure — the volume
stays deleting and the worker re-attempts it about once a
minute until the blocker clears (delete the snapshots and it
goes); nothing needs re-issuing. Cleared on any other transition.
AWS-shape resource tags. Freeform UTF-8 keys (1-128 bytes, no
leading/trailing whitespace) mapped to freeform UTF-8 values
(0-256 bytes). Max 50 tags per resource. Reserved prefixes
(stratum.dev/, stratum.platform_health., stratum:,
aws:) return 400 RESERVED_NAMESPACE on customer input.
PATCH replaces the whole map..
object
The volume’s IOPS ceiling, applied as libvirt
The volume’s throughput ceiling in MB/s, like iopsLimit. Counts toward storage.io.mbps.
Example
{ "driver": "lvm-thin", "state": "creating", "attachmentMode": "rw"}Bad request.
object
The findings of a rejected IAM policy document (custom and resource policies).
One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.
object
The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.
Index of the statement at fault; -1 for the document as a whole.
The offending action, where one is at fault (ACTION_NOT_APPLICABLE).
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.
One field’s problem, the stage-2 installer API’s shape.
field is the field’s path, message what is wrong with it.
object
The field’s path, e.g. links[0].interface, disks[1].confirm,
mgmt.address or role; empty for the whole request.
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
Example
{ "issues": [ { "code": "ACTION_NOT_APPLICABLE", "action": "compute:CreateVpc" } ]}Authenticated but not authorized.
object
The findings of a rejected IAM policy document (custom and resource policies).
One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.
object
The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.
Index of the statement at fault; -1 for the document as a whole.
The offending action, where one is at fault (ACTION_NOT_APPLICABLE).
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.
One field’s problem, the stage-2 installer API’s shape.
field is the field’s path, message what is wrong with it.
object
The field’s path, e.g. links[0].interface, disks[1].confirm,
mgmt.address or role; empty for the whole request.
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
Example
{ "issues": [ { "code": "ACTION_NOT_APPLICABLE", "action": "compute:CreateVpc" } ]}Resource not found.
object
The findings of a rejected IAM policy document (custom and resource policies).
One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.
object
The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.
Index of the statement at fault; -1 for the document as a whole.
The offending action, where one is at fault (ACTION_NOT_APPLICABLE).
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.
One field’s problem, the stage-2 installer API’s shape.
field is the field’s path, message what is wrong with it.
object
The field’s path, e.g. links[0].interface, disks[1].confirm,
mgmt.address or role; empty for the whole request.
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
Example
{ "issues": [ { "code": "ACTION_NOT_APPLICABLE", "action": "compute:CreateVpc" } ]}IMAGE_POOL_MISMATCH — storageClass cannot hold a clone of
this image: it is on another storage driver, or (lvm-thin, where
a clone is a VG-local thin snapshot) on a pool the image is not
staged in. Nothing is created. details (ImagePoolMismatchDetails)
names the image’s pools, the class asked for and storageClasses,
the classes that can launch it, equal to the image’s
launchableStorageClasses; omitting storageClass always can.
Other conflicts on this route: IMAGE_DISABLED, INVALID_STATE
and NAME_TAKEN.
A 409 on a route that can answer IMAGE_POOL_MISMATCH: a
Problem whose details, for that code, is an ImagePoolMismatchDetails.
The route’s other conflict codes carry no details.
object
The findings of a rejected IAM policy document (custom and resource policies).
One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.
object
The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.
Index of the statement at fault; -1 for the document as a whole.
The offending action, where one is at fault (ACTION_NOT_APPLICABLE).
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.
One field’s problem, the stage-2 installer API’s shape.
field is the field’s path, message what is wrong with it.
object
The field’s path, e.g. links[0].interface, disks[1].confirm,
mgmt.address or role; empty for the whole request.
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
details of a 409 IMAGE_POOL_MISMATCH problem,
the same on POST /v1/projects/{projectId}/compute/instances and the
image create-volume action: the storage class asked for cannot hold a
clone of the image.
object
The storage driver the image is stored on.
The pools the image’s base lives in.
The storage class asked for, by name.
The driver that class puts volumes on.
The pool that class puts volumes in.
The classes, by name, that can launch the image (equal to the image’s
launchableStorageClasses). Omitting the class always can.
Example
{ "issues": [ { "code": "ACTION_NOT_APPLICABLE", "action": "compute:CreateVpc" } ]}