REST - Wirtualne dyski

Listowanie wirtualnych dysków

Zapytanie

GET /v2/storage-volumes

Zwraca tablicę z listą istniejących wirtualnych dysków.

Odpowiedź

{  
  "success":true,
  "storage_volumes": [
     {
       "id":"$volume_id",
       "label":"$volume_label",
       "size": $volume_size,
       "cost_per_hour": $volume_cost,
       "type": "$volume_type",
       "system_disk": $volume_system,
 
       // jeśli shared_disk jest równy false to
       // pole 'virtual_machine' będzie istniało jeżeli
       // dysk jest podłączony do wirtualnej maszyny
        "shared_disk": $shared_disk, //jesli = false
        "virtual_machine": {
           "id": "$vm_id",
           "label": "$vm_label",
           "attach_time": "$attach_time"
        }

        // jeśli shared_disk jest równy true to
        // pole 'virtual_machines' będzie istniało jeżeli dysk
        // jest podłączony do co najmniej jednej wirtualnej maszyny
        "shared_disk": $shared_disk, //jesli = true
        "virtual_machines": [{
              "id": "$vm_id",
              "label": "$vm_label",
              "attach_time": "$attach_time",
            },
            { ... },
            {
              "id": "$vm_id",
              "label": "$vm_label",
              "attach_time": "$attach_time"
           }
        ]
     },
    { ... }
  ]
}

Zwracane informacje

$volume_id (string) - UUID wirtualnego dysku
$volume_label (string) - nazwa wirtualnego dysku
$volume_size (int) - wielkość dysku (w GB)
$volume_cost (float) - koszt dysku na godzinę
$volume_system (int) - określa czy dysk jest dyskiem systemowym
$volume_type (string) - określa rodzaj dysku HDD/SSD
$shared_disk (bool) - określa czy dysk jest dyskiem współdzielonym czy zwykłym
$vm_id (string) - UUID wirtualnej maszyny, do której podłączony jest dysk
$vm_label (string) - nazwa wirtualnej maszyny, do której podłączony jest dysk
$attach_time (datetime) - data i czas podłączenia dysku do serwera wirtualnego

Pobieranie informacji o wirtualnym dysku

Zapytanie

GET /v2/storage-volumes/$VOLUME_ID

Zwraca informacje o wirtualnym dysku, o podanym $VOLUME_ID.

Odpowiedź

{  
  "success":true,
  "storage_volume": [
     {
       "id": "$volume_id",
       "label": "$volume_label",
       "size": $volume_size,
       "cost_per_hour": $volume_cost,
       "type": "$volume_type",
       "system_disk": $volume_system,

       // jeśli shared_disk jest równy false to
       // pole 'virtual_machine' będzie istniało jeżeli
       // dysk jest podłączony do wirtualnej maszyny
        "shared_disk": $shared_disk, //jesli = false
        "virtual_machine": {
           "id": "$vm_id",
           "label": "$vm_label",
           "attach_time": "$attach_time"
        }

        // jeśli shared_disk jest równy true to
        // pole 'virtual_machines' będzie istniało jeżeli dysk
        // jest podłączony do co najmniej jednej wirtualnej maszyny
        "shared_disk": $shared_disk, //jesli = true
        "virtual_machines": [{
              "id": "$vm_id",
              "label": "$vm_label",
              "attach_time": "$attach_time",
            },
            { ... },
            {
              "id": "$vm_id",
              "label": "$vm_label",
              "attach_time": "$attach_time"
           }
        ]
     }
  ]
}

Zwracane informacje

$volume_id (string) - UUID wirtualnego dysku
$volume_label (string) - nazwa wirtualnego dysku
$volume_size (int) - wielkość dysku (w GB)
$volume_cost (float) - koszt dysku na godzinę
$volume_system (int) - określa czy dysk jest dyskiem systemowym
$volume_type (string) - określa rodzaj dysku HDD/SSD
$shared_disk (bool) - określa czy dysk jest dyskiem współdzielonym, czy standardowym
$vm_id (string) - UUID wirtualnej maszyny, do której podłączony jest dysk
$vm_label (string) - nazwa wirtualnej maszyny, do której podłączony jest dysk
$attach_time (datetime) - data i czas podłączenia dysku do serwera wirtualnego

Podłączanie wirtualnego dysku

Zapytanie

POST /v2/storage-volumes/$VOLUME_ID/attach

Zawartość zapytania

{
   "virtual_machine_id": "$vm_id"
}

Opis parametrów

$vm_id (string) - UUID wirtualnej maszyny

Odpowiedź

{  
  "success":true
}

Odłączanie wirtualnego dysku

Zapytanie

POST /v2/storage-volumes/$VOLUME_ID/detach

Dodaje zadanie odłączenia dysku $VOLUME_ID od wirtualnej maszyny. Dysk musi być podłączony do wirtualnej maszyny, aby operacja się powiodła.

Odpowiedź

{  
  "success":true
}

Dodawanie wirtualnego dysku

Zapytanie

PUT /v2/storage-volumes

Dodaje nowy dysk wirtualny.

Zawartość zapytania

{
    "zone_id": "$location_id",
    "type": "$disk_type",
    "name": "$disk_label",
    "shared_volume": $shared_volume,
    "size": $disk_size,
    "recovery_point_id": "$recovery_point_id"
}

Opis parametrów

$location_id (string) - UUID lokalizacji
$disk_type (string) - typ dysku (ssd/hdd)
$disk_label (string) - nazwa obrazu
$shared_volume (int) - czy dysk jest współdzielony (¹⁄₀)
$disk_size (int) - wielkość dysku (w GB)
$recovery_point_id (string) - opcjonalny parametr UUID obrazu punktu przywracania, po jego podaniu dysk zostanie utworzony z punktu przywracania

Odpowiedź

{  
  "success":true
}

Usuwanie wirtualnego dysku

Zapytanie

DELETE /v2/storage-volumes/$VOLUME_ID

Dodaje zadanie usunięcia dysku $VOLUME_ID. Jeżeli dysk jest podłączony do wirtualnej maszyny, zostanie od niej automatycznie odłączony.

Odpowiedź

{  
  "success":true
}

Updated on 05 Sep 2023