SOsodafoundation
Block volumes

GET /v1beta/{tenantId}/block/volumes

Changed on

Lists information for all volumes.

Request

  • Base URL
    https://localhost:50040
  • Auth
    HTTP basic

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"
    }
  }
]

Changes

  • b151718b45cfRevision changes
    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter name

    • info

      added the new optional query request parameter offset

    • info

      added the new optional query request parameter poolId

    • info

      added the new optional query request parameter profileId

    • info

      added the new optional query request parameter sortDir

    • info

      added the new optional query request parameter sortKey

    • info

      added the new optional query request parameter status

    • info

      added the optional property // to the response with the status

  • a41e1157d0e7Revision changes
    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status