API - Sąveika su Backup

Šiame dokumente aprašomas atsarginių kopijų kūrimo, peržiūros ir šalinimo procesas instance naudojant Zomro paslaugos API. Pateikti užklausų pavyzdžiai padės greitai suprasti pagrindines operacijas, reikalingas atsarginių kopijų valdymui per API.

Atsarginės kopijos kūrimas

Norėdami sukurti atsarginę kopiją, atlikite šią užklausą:

URL:

https://api.zomro.com/

Metodas: POST

Užklausos kūnas (Form-data):

Parametras	Pavyzdinė vertė	Privalomas parametras	Vertės aprašymas
func	instances.fleio_bckps.edit	Taip	Funkcija, skirta atsarginės kopijos kūrimui
auth	21fc199...c43f71	Ne	Sesijos žetonas. Tai vienas iš autorizacijos būdų. Daugiau apie kitus būdus aprašyta čia
out	json	Taip	Atsakymo tipas, kurio tikėtis
sok	ok	Taip	Operacijos patvirtinimas
plid	5203773	Taip	ID instance, kuriai sukurti atsarginę kopiją
name	MyBackup	Taip	Atsarginės kopijos pavadinimas

Pavyzdys, kaip sukurti atsarginę kopiją paslaugai

Pavyzdžiui, naudojame paslaugą:

URL:

https://api.zomro.com/

Metodas: POST

Užklausos kūnas (Form-data):

Parametras	Vertė
func	instances.fleio_bckps.edit
auth	21fc199...c43f71
out	json
sok	ok
plid	5203773
name	MyBackup

Štai pavyzdys užklausos, kurią galima atlikti iš konsolės:

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 užklausos atlikimo matome, kad atsarginė kopija kuriama. Kaip matome, backup turi vertę Saving:

Po atsarginės kopijos kūrimo pabaigos, atsarginės kopijos statusas pasikeis iš Saving į Active:

Kaip matome, paslaugos statusas yra Active.

Kaip gauti atsarginių kopijų sąrašą naudojant API

Taip pat, naudojant API galima gauti atsarginių kopijų sąrašą. Tam atlikite šią užklausą:

URL:

https://api.zomro.com/

Metodas: POST

Užklausos kūnas (Form-data):

Parametras	Pavyzdinė vertė	Privalomas parametras	Vertės aprašymas
func	instances.fleio_bckps	Taip	Funkcija, skirta gauti visas atsargines kopijas
auth	21fc199...c43f71	Ne	Sesijos žetonas. Tai vienas iš autorizacijos būdų. Daugiau apie kitus būdus aprašyta čia
out	json	Taip	Atsakymo tipas, kurio tikėtis
plid	5203773	Taip	ID instance, kurios atsargines kopijas planuojama gauti

Pavyzdžiui, pabandykime gauti atsargines kopijas paslaugai 5203773. Ankstesniame žingsnyje sukūrėme 1 atsarginę kopiją. Pabandykime ją gauti.

Pabandykime atlikti šią užklausą konsolėje:

curl --location 'https://api.zomro.com/' \
--form 'func="instances.fleio_bckps"' \
--form 'auth="8409b4eea786e3cad35eacf7"' \
--form 'out="json"' \
--form 'elid="5203773"'

Gauname šį rezultatą:

{
    "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"
                }
            }
        ],
    }
}

Mus domina duomenys, kurie gauti šioje struktūroje:

doc.elem.[]

Iš šio atsakymo gauname šiuos duomenis:

Lauko pavadinimas	Aprašymas
architecture	Virtualios mašinos architektūra
backup_type	Kaip buvo sukurta atsarginė kopija: rankiniu būdu ar pagal tvarkaraštį
createdate	Atsarginės kopijos sukūrimo laikas
disk_format	Atsarginės kopijos failo tipas
fleio_id	Unikalus UUID fleio sistemoje
fleio_status	Atsarginės kopijos statusas. Vertė Active reiškia, kad atsarginė kopija sukurta
hypervisor_type	Virtualios mašinos hipervizoriaus tipas
id	Atsarginės kopijos ID bill manager sistemoje
image_size	Faktinis atsarginės kopijos dydis. Nustatomas po atsarginės kopijos kūrimo pabaigos
item_real_status	Paslaugos statusas billmanager sistemoje
min_disk	Minimalus disko dydis serveryje, reikalingas atsarginei kopijai atkurti
min_ram	Minimalus RAM dydis serveryje, reikalingas atsarginei kopijai atkurti
name	Atsarginės kopijos pavadinimas
os_distro	Operacinės sistemos pavadinimas
os_version	Operacinės sistemos versija
protected	Informuoja, ar leidžiama ištrinti atsarginę kopiją. Vertė «off» reiškia, kad atsarginę kopiją galima ištrinti. Vertė «on» reiškia, kad atsarginės kopijos ištrinti negalima.
region	Duomenų centro, kuriame yra atsarginė kopija, pavadinimas
visibility	Atsarginės kopijos prieigos statusas. Vienintelė prieinama vertė yra «Private»

Kaip ištrinti atsarginę kopiją

Norėdami ištrinti atsarginę kopiją, atlikite šią užklausą

URL:

https://api.zomro.com/

Metodas: POST

Užklausos kūnas (Form-data):

Parametras	Pavyzdinė vertė	Privalomas parametras	Vertės aprašymas
func	image.delete	Taip	Funkcija, skirta atsarginės kopijos šalinimui
auth	21fc199...c43f71	Ne	Sesijos žetonas. Tai vienas iš autorizacijos būdų. Daugiau apie kitus būdus aprašyta čia
out	json	Taip	Atsakymo tipas, kurio tikėtis
plid	5203773	Taip	ID instance, kurios atsargines kopijas planuojama gauti
elname	5203980	Taip	ID atsarginės kopijos, kurią reikia ištrinti
elid	5203980	Taip	ID atsarginės kopijos, kurią reikia ištrinti
sok	ok	Taip	Operacijos patvirtinimas

Pabandykime atlikti šią užklausą konsolėje:

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 užklausos atlikimo, rezultatą galima patikrinti naudojant funkciją «instances.fleio_bckps» arba peržiūrint per žiniatinklio sąsają:

Kaip matome, atsarginė kopija buvo sėkmingai ištrinta.

Taip pat siūlome susipažinti su straipsniais, kurie gali būti naudingi sąveikai su Cloud VPS produktais naudojant API: