v1

latestSwagger 2.0APACHE22026-07-17496086.3 KB
volume

Enumerate all volumes

get/osd-volumes

Query parameters

Namestring

User specified volume name (Case Sensitive)

VolumeIDstring uuid

Volume UUID

Response

an array of volumes

CreatedAtstring

Date/Time the volume was created.

Driverstring required

Name of the volume driver used by the volume.

Labelsobject required

User-defined key/value metadata.

Mountpointstring required

Mount path of the volume on the host.

Namestring required

Name of the volume.

Optionsobject required

The driver specific options used when creating the volume.

Scopestring required

The level at which the volume exists. Either global for cluster-wide, or local for machine level.

Statusobject

Low-level details about the volume, provided by the volume driver. Details are returned as a map with key/value pairs: {"key":"value","key2":"value2"}.

The Status field is optional, and is omitted if the volume driver does not support this feature.