Sign in

v1

latestSwagger 2.02026-07-17111025.6 KB
Volume

List volumes

List of volumes that match the query.

get/namespaces/{namespace}/volumes

Path parameters

namespacestring required

The object scope, such as for teams and projects.

Query parameters

labelSelectorstring

A selector to restrict the list of returned objects by their labels. Defaults to everything.

fieldSelectorstring

A selector to restrict the list of returned objects by their fields. Defaults to everything.

timeoutSecondsinteger

Timeout for the list call.

namespacestring

Object name and auth scope, such as for teams and projects.

Response

Success

IDstring

Volume unique ID.

Namestring required

Volume name.

Descriptionstring

Volume description.

Sizeinteger required

Size in GB.

Poolstring

Name of capacity pool to provision the volume in, or the name of the current pool.

Labelsobject

User-defined key/value metadata.

Statusstring

Short status, one of: pending, evaluating, deploying, active, unavailable, failed, updating, deleting.

StatusMessagestring

Status message explaining current status.

Healthstring

Volume health, one of: healthy, degraded or dead.

Inodeinteger

Block device inode.

Deletedboolean

Flag indicating if the volume has been deleted and is waiting for scrubbing.

Mountedboolean

Flag indicating if the volume is mounted and in use.

MountedBystring

Reference to the node that has the volume mounted.

Mountpointstring

Mountpoint where the volume was mounted.

MountedAtstring dateTime

When the volume was mounted.

CreatedBystring

User that created the volume.

CreatedAtstring dateTime

When the volume was created.

Example response

[
  {
    "Name": "vol01",
    "Size": 5,
    "Labels": {
      "com.example.some-label": "some-value",
      "com.example.some-other-label": "some-other-value"
    }
  }
]
All 11 operations