SOsodafoundation
Volumes

GET /v1/volumes

Changed on

List all storage volumes.

Request

  • The document declares no server URL.
  • Auth
    none declared

Query parameters

limitinteger

Requests a page size of items. Returns a number of items up to a limit value. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request.

offsetinteger

Used in conjunction with limit to return a slice of items. offset is where to start in the list.

sortstring
Example:sort=name:desc,id:asc

Comma-separated list of sort keys and optional sort directions in the form of key:val

namestring

The volume name

native_storage_pool_idstring

Actual ID of the storage pool in the storage backend.

native_volume_idstring

Actual ID created for the volume in the storage backend.

storage_idstring

Database ID created for a storage backend.

status'noraml' | 'offline' | 'abnormal'

The volume status

Response

List volumes operation was successful

Example response

{
  "volumes": [
    {
      "id": "084bf71e-a102-11e7-88a8-e31fe6d52248",
      "created_at": "2017-07-10T14:36:58.014Z",
      "updated_at": "2017-07-10T14:36:58.014Z",
      "storage_id": "084bf71e-a102-11e7-88a8-e31fe6d52248",
      "total_capacity": 2,
      "used_capacity": 2,
      "free_capacity": 2
    }
  ]
}

Changes

  • f1e0eabbadb5Revision changes
    • info

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

  • 3d3829cf1352Revision changes
    • warning

      added the new available enum value to the /// response property for the response status

    • warning

      added the new error enum value to the /// response property for the response status

    • info

      removed the abnormal enum value from the /// response property for the response status

    • info

      removed the normal enum value from the /// response property for the response status

    • info

      removed the offline enum value from the /// response property for the response status