Retrieve block storage volume details

GET /block-storage/{id}

Path parameters

  • id string(uuid) Required

Responses

  • • 200 application/json

    200

    Hide response attributes Show response attributes object
    • labels object

      Resource labels

      Hide labels attributes Show labels attributes
    • instance object

      Volume attached instance, if any

      Hide instance attribute Show instance attribute
      • id string(uuid)

        Instance ID

    • name string

      Volume name

      Minimum length is 1, maximum length is 255.

    • state string

      Volume state

      Values are snapshotting, deleted, creating, detached, deleting, attaching, error, attached, or detaching.

    • size integer(int64)

      Volume size

      Minimum value is 10.

    • blocksize integer(int64)

      Volume block size

      Minimum value is 0.

    • block-storage-snapshots array[object]

      Target block storage snapshot

      Hide block-storage-snapshots attribute Show block-storage-snapshots attribute object
      • id string(uuid)

        Block storage snapshot ID

    • id string(uuid)

      Volume ID

    • created-at string(date-time)

      Volume creation date
GET /block-storage/{id} 
curl \
 -X GET https://api-ch-gva-2.exoscale.com/v2/block-storage/{id}
Response examples (200) 
{
  "labels": {
    "key": "string"
  },
  "instance": {
    "id": "string"
  },
  "name": "string",
  "state": "snapshotting",
  "size": 42,
  "blocksize": 42,
  "block-storage-snapshots": [
    {
      "id": "string"
    }
  ],
  "id": "string",
  "created-at": "2024-05-04T09:42:00+00:00"
}