v1

latestOpenAPI 3.0.0Apache 2.02026-07-176940115.5 KB
Block volumes

Lists information for all volumes.

get/v1beta/{tenantId}/block/volumes

Query parameters

limitinteger

Number of query results on multiple pages

offsetinteger

Start position of the pagination query

sortDir'asc' | 'desc'

Ascending or descending

sortKeystring

Sorting key word, such as name, createdAt

namestring

The volume name

profileIdstring

The UUID of profile

poolIdstring

The UUID of pool

statusstring

The volume status

Response

OK

idstring
createdAtstring date-time
updatedAtstring date-time
tenantIdstring
userIdstring
namestring
multiAttachboolean
descriptionstring
sizeinteger
availabilityZonestring
statusstring
profileIdstring
poolIdstring
snapshotIdstring
groupIdstring
snapshotFromCloudboolean
replicationIdstring
replicationDriverDataobject
metadataobject

Example response

[
  {
    "id": "084bf71e-a102-11e7-88a8-e31fe6d52248",
    "createdAt": "2017-07-10T14:36:58.014Z",
    "updatedAt": "2017-07-10T14:36:58.014Z",
    "size": 2,
    "replicationDriverData": {
      "key1": "value1",
      "key2": "value2"
    },
    "metadata": {
      "key1": "value1",
      "key2": "value2"
    }
  }
]