Sign in

v1

latestSwagger 2.02026-07-17111025.6 KB
Pool

Get a pool

Gets a pool by name or ID. Returns to whole pool object.

get/pools/{name}

Path parameters

namestring required

Volume name or ID.

Response

Success

IDstring

Pool unique ID.

Namestring required

Pool name.

Descriptionstring

Pool description.

Defaultboolean

Default determines whether this pool is the default if a volume is provisioned without a pool specified. There can only be one default pool.

DefaultDriverstring

DefaultDriver specifies the storage driver to use by default if there are multiple drivers in the pool and no driver was specified in the provisioning request or assigned by rules. If no driver was specified and no default set, driver weight is used to determine the default.

ControllerNamesstring[]

ControllerNames is a list of controller names that are participating in the storage pool.

DriverNamesstring[]

DriverNames is a list of backend storage drivers that are available in the storage pool.

Activeboolean

Flag describing whether rule is active.

Labelsobject

Labels define a list of labels that describe the pool.