SOsodafoundation
Volumes

GET /v1/volumes/{id}

Changed on

Get storage volume detail by volume ID.

Request

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

Path parameters

idstring required

Database ID created for a volume.

Response

OK

idstring
created_atstring date-time
updated_atstring date-time
namestring
descriptionstring
status'available' | 'error'
storage_idstring
total_capacityinteger
used_capacityinteger
free_capacityinteger
compressedboolean
deduplicatedboolean
type'thick' | 'thin'
native_volume_idstring
wwnstring
native_storage_pool_idstring

Example response

{
  "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
    • warning

      deleted the path request parameter storage_id

    • 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