W tym dokumencie opisano proces tworzenia, przeglądania i usuwania kopii zapasowych dla instancji za pomocą API serwisu Zomro. Przykłady zapytań pomogą Ci szybko zrozumieć podstawowe operacje niezbędne do zarządzania kopiami zapasowymi przez API.
Tworzenie kopii zapasowej
Aby utworzyć kopię zapasową, wykonaj następujące zapytanie:
URL:
https://api.zomro.com/
Metoda: POST
Treść zapytania (Form-data):
Parametr | Przykładowa wartość | Obowiązkowy parametr | Opis wartości |
func | instances.fleio_bckps.edit | Tak | Funkcja do tworzenia kopii zapasowej |
auth | 21fc199...c43f71 | Nie | Token sesji. Jest to jedna z opcji autoryzacji. Więcej informacji o innych opcjach znajduje się tutaj |
out | json | Tak | Typ odpowiedzi, której oczekiwać |
sok | ok | Tak | Potwierdzenie operacji |
plid | 5203773 | Tak | ID instancji, dla której utworzyć kopię zapasową |
name | MyBackup | Tak | Nazwa kopii zapasowej |
Przykład tworzenia kopii zapasowej dla usługi
Na przykład, użyjemy usługi:
URL:
https://api.zomro.com/
Metoda: POST
Treść zapytania (Form-data):
Parametr | Wartość |
func | instances.fleio_bckps.edit |
auth | 21fc199...c43f71 |
out | json |
sok | ok |
plid | 5203773 |
name | MyBackup |
Oto przykład zapytania, które można wykonać z konsoli:
curl --location 'https://api.zomro.com/' \
--form 'func="instances.fleio_bckps.edit"' \
--form 'auth="d3ec30e337e01078a1d185cc"' \
--form 'out="json"' \
--form 'sok="ok"' \
--form 'plid="5203773"' \
--form 'name="MyBackup"'
Po wykonaniu zapytania, widzimy, że kopia zapasowa jest w trakcie tworzenia. Jak widać, backup ma wartość Saving:
Po zakończeniu tworzenia kopii zapasowej, status kopii zapasowej zmieni się z Saving na Active:
Jak widać, status usługi jest Active.
Jak uzyskać listę kopii zapasowych za pomocą API
Również za pomocą API można uzyskać listę kopii zapasowych. W tym celu wykonujemy następujące zapytanie:
URL:
https://api.zomro.com/
Metoda: POST
Treść zapytania (Form-data):
Parametr | Przykładowa wartość | Obowiązkowy parametr | Opis wartości |
func | instances.fleio_bckps | Tak | Funkcja do uzyskania wszystkich kopii zapasowych |
auth | 21fc199...c43f71 | Nie | Token sesji. Jest to jedna z opcji autoryzacji. Więcej informacji o innych opcjach znajduje się tutaj |
out | json | Tak | Typ odpowiedzi, której oczekiwać |
plid | 5203773 | Tak | ID instancji, której kopie zapasowe planuje się uzyskać |
Na przykład, spróbujemy uzyskać kopie zapasowe dla usługi 5203773. W poprzednim kroku utworzyliśmy 1 kopię zapasową. Spróbujmy ją uzyskać.
Spróbujmy wykonać następujące zapytanie w konsoli:
curl --location 'https://api.zomro.com/' \
--form 'func="instances.fleio_bckps"' \
--form 'auth="8409b4eea786e3cad35eacf7"' \
--form 'out="json"' \
--form 'elid="5203773"'
Otrzymujemy następujący wynik:
{
"doc": {
...
"elem": [
{
"architecture": {
"$": "x86_64"
},
"backup_type": {
"$": "manual"
},
"createdate": {
"$": "2024-07-23"
},
"disk_format": {
"$": "qcow2"
},
"fleio_id": {
"$": "b26c0f34-48b2-4cb2-b4eb-388eac959df6"
},
"fleio_status": {
"$": "Active"
},
"hypervisor_type": {
"$": "any_hypervisor"
},
"id": {
"$": "5203980"
},
"image_size": {
"$": "3"
},
"item_real_status": {
"$": "2"
},
"min_disk": {
"$": "20"
},
"min_ram": {
"$": "0"
},
"name": {
"$": "MyBackup"
},
"os_distro": {
"$": "Ubuntu"
},
"os_version": {
"$": "22.04 x64"
},
"protected": {
"$": "off"
},
"region": {
"$": "Netherlands-2"
},
"visibility": {
"$": "private"
}
}
],
}
}
Interesują nas dane, które otrzymujemy w następującej strukturze:
doc.elem.[]
Z tej odpowiedzi otrzymujemy następujące dane:
Nazwa pola | Opis |
architecture | Architektura maszyny wirtualnej |
backup_type | W jaki sposób została utworzona kopia zapasowa: Ręcznie czy według harmonogramu |
createdate | Czas utworzenia kopii zapasowej |
disk_format | Typ pliku kopii zapasowej |
fleio_id | Unikalny UUID w systemie fleio |
fleio_status | Status kopii zapasowej. Wartość Active oznacza, że kopia zapasowa została utworzona |
hypervisor_type | Typ hypervisora dla maszyny wirtualnej |
id | ID kopii zapasowej w ramach bill manager |
image_size | Rzeczywisty rozmiar kopii zapasowej. Określany po zakończeniu tworzenia kopii zapasowej |
item_real_status | Status usługi w ramach billmanager |
min_disk | Minimalny rozmiar dysku na serwerze potrzebny do przywrócenia tej kopii zapasowej |
min_ram | Minimalny rozmiar RAM na serwerze potrzebny do przywrócenia tej kopii zapasowej |
name | Nazwa kopii zapasowej |
os_distro | Nazwa systemu operacyjnego |
os_version | Wersja systemu operacyjnego |
protected | Informuje, czy usunięcie kopii zapasowej jest dozwolone. Przy wartości "off" kopię zapasową można usunąć. W przypadku "on" - kopii zapasowej nie można usunąć. |
region | Nazwa centrum danych, w którym znajduje się kopia zapasowa |
visibility | Status dostępu do kopii zapasowej. Jedyną dostępną wartością jest "Private" |
Jak usunąć kopię zapasową
Aby usunąć kopię zapasową, wykonaj następujące zapytanie:
URL:
https://api.zomro.com/
Metoda: POST
Treść zapytania (Form-data):
Parametr | Przykładowa wartość | Obowiązkowy parametr | Opis wartości |
func | image.delete | Tak | Funkcja do usunięcia kopii zapasowej |
auth | 21fc199...c43f71 | Nie | Token sesji. Jest to jedna z opcji autoryzacji. Więcej informacji o innych opcjach znajduje się tutaj |
out | json | Tak | Typ odpowiedzi, której oczekiwać |
plid | 5203773 | Tak | ID instancji, której kopie zapasowe planuje się uzyskać |
elname | 5203980 | Tak | ID kopii zapasowej, którą należy usunąć |
elid | 5203980 | Tak | ID kopii zapasowej, którą należy usunąć |
sok | ok | Tak | Potwierdzenie wykonania operacji |
Spróbujmy wykonać następujące zapytanie w konsoli:
curl --location 'https://api.zomro.com/' \
--form 'func="image.delete"' \
--form 'auth="72307c8cfc94e631d835438f"' \
--form 'out="json"' \
--form 'sok="ok"' \
--form 'plid="5203773"' \
--form 'elname="5203980"' \
--form 'elid="5203980"'
Po wykonaniu zapytania, wynik można sprawdzić za pomocą funkcji „instances.fleio_bckps” lub przeglądając za pomocą interfejsu webowego:
Jak możemy zobaczyć, kopia zapasowa została pomyślnie usunięta.
Również proponujemy zapoznać się z artykułami, które mogą być przydatne do interakcji z produktami Cloud VPS za pomocą API:
- API - Tworzenie usługi
- API - Uzyskiwanie informacji o dostępnych taryfach i ich parametrach
- API - Operacja Start & Stop
- API - Operacja Reboot
- API - Operacja Rebuild
- API - Operacja Delete
- API - Interakcja z Image
- API - Interakcja z Backup Schedule
- API - Interakcja z Rescue
- API - Interakcja z Snapshots
- API - Interakcja z Boot From ISO