API - Mijiedarbība ar Backup

Šajā dokumentā ir aprakstīts process, kā izveidot, skatīt un dzēst rezerves kopijas instancei, izmantojot Zomro pakalpojuma API. Sniedzot pieprasījumu piemērus, jūs ātri sapratīsiet galvenās darbības, kas nepieciešamas, lai pārvaldītu rezerves kopijas caur API.

Rezerves kopijas izveide

Lai izveidotu rezerves kopiju, izpildiet šādu pieprasījumu:

URL:

https://api.zomro.com/

Metode: POST

Pieprasījuma ķermenis (Form-data):

Parametrs	Vērtības piemērs	Obligāts parametrs	Vērtības apraksts
func	instances.fleio_bckps.edit	Jā	Funkcija, lai izveidotu rezerves kopiju
auth	21fc199...c43f71	Nē	Sesijas tokens. Tas ir viens no autorizācijas veidiem. Plašāka informācija par citiem veidiem ir aprakstīta šeit
out	json	Jā	Atbildes tips, kuru sagaidīt
sok	ok	Jā	Operācijas apstiprinājums
plid	5203773	Jā	Instance ID, kurai izveidot rezerves kopiju
name	MyBackup	Jā	Rezerves kopijas nosaukums

Rezerves kopijas izveides piemērs pakalpojumam

Piemēram, izmantojam pakalpojumu:

URL:

https://api.zomro.com/

Metode: POST

Pieprasījuma ķermenis (Form-data):

Parametrs	Vērtība
func	instances.fleio_bckps.edit
auth	21fc199...c43f71
out	json
sok	ok
plid	5203773
name	MyBackup

Šeit ir pieprasījuma piemērs, kuru var izpildīt no konsoles:

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"'

Pēc pieprasījuma izpildes redzam, ka rezerves kopija ir izveides procesā. Kā redzam, backup ir vērtība Saving:

Pēc rezerves kopijas izveides pabeigšanas, rezerves kopijas statuss mainīsies no Saving uz Active:

Kā redzam, pakalpojuma statuss ir Active.

Kā iegūt rezerves kopiju sarakstu, izmantojot API

Arī, izmantojot API, ir iespējams iegūt rezerves kopiju sarakstu. Lai to izdarītu, izpildiet šādu pieprasījuma formātu:

URL:

https://api.zomro.com/

Metode: POST

Pieprasījuma ķermenis (Form-data):

Parametrs	Vērtības piemērs	Obligāts parametrs	Vērtības apraksts
func	instances.fleio_bckps	Jā	Funkcija, lai iegūtu visas rezerves kopijas
auth	21fc199...c43f71	Nē	Sesijas tokens. Tas ir viens no autorizācijas veidiem. Plašāka informācija par citiem veidiem ir aprakstīta šeit
out	json	Jā	Atbildes tips, kuru sagaidīt
plid	5203773	Jā	Instance ID, kuras rezerves kopijas plānots iegūt

Piemēram, mēģināsim iegūt rezerves kopijas pakalpojumam 5203773. Iepriekšējā solī izveidojām 1 rezerves kopiju. Mēģināsim to iegūt.

Mēģināsim izpildīt šādu pieprasījumu konsolē:

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

Iegūstam šādu rezultātu:

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

Mūs interesē dati, kas iegūti šādā ligzdojumā:

doc.elem.[]

No šīs atbildes mēs iegūstam šādus datus:

Lauka nosaukums	Apraksts
architecture	Virtuālās mašīnas arhitektūra
backup_type	Kādā veidā tika izveidota rezerves kopija: Manuāli vai pēc grafika
createdate	Rezerves kopijas izveides laiks
disk_format	Rezerves kopijas faila tips
fleio_id	Unikāls UUID fleio sistēmā
fleio_status	Rezerves kopijas statuss. Vērtība Active nozīmē, ka rezerves kopija ir izveidota
hypervisor_type	Virtuālās mašīnas hipervizora tips
id	Rezerves kopijas ID bill manager ietvaros
image_size	Faktiskais rezerves kopijas izmērs. Nosakāms pēc rezerves kopijas izveides pabeigšanas
item_real_status	Pakalpojuma statuss billmanager ietvaros
min_disk	Minimālais diska izmērs serverī, kas nepieciešams, lai atjaunotu šo rezerves kopiju
min_ram	Minimālais RAM izmērs serverī, kas nepieciešams, lai atjaunotu šo rezerves kopiju
name	Rezerves kopijas nosaukums
os_distro	Operētājsistēmas nosaukums
os_version	Operētājsistēmas versija
protected	Informē, vai ir atļauts dzēst rezerves kopiju. Ja vērtība ir "off", rezerves kopiju var dzēst. Ja vērtība ir "on", rezerves kopiju nevar dzēst.
region	Datacentra nosaukums, kur atrodas rezerves kopija
visibility	Piekļuves statuss rezerves kopijai. Vienīgā pieejamā vērtība ir "Private"

Kā dzēst rezerves kopiju

Lai dzēstu rezerves kopiju, izpildiet šādu pieprasījumu:

URL:

https://api.zomro.com/

Metode: POST

Pieprasījuma ķermenis (Form-data):

Parametrs	Vērtības piemērs	Obligāts parametrs	Vērtības apraksts
func	image.delete	Jā	Funkcija, lai dzēstu rezerves kopiju
auth	21fc199...c43f71	Nē	Sesijas tokens. Tas ir viens no autorizācijas veidiem. Plašāka informācija par citiem veidiem ir aprakstīta šeit
out	json	Jā	Atbildes tips, kuru sagaidīt
plid	5203773	Jā	Instance ID, kuras rezerves kopijas plānots iegūt
elname	5203980	Jā	Rezerves kopijas ID, kuru nepieciešams dzēst
elid	5203980	Jā	Rezerves kopijas ID, kuru nepieciešams dzēst
sok	ok	Jā	Operācijas apstiprinājums

Mēģināsim izpildīt šādu pieprasījumu konsolē:

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"'

Pēc pieprasījuma izpildes rezultātu var pārbaudīt, izmantojot funkciju "instances.fleio_bckps", vai apskatot to caur tīmekļa saskarni:

Kā redzam, rezerves kopija tika veiksmīgi dzēsta.

Arī piedāvājam izpētīt rakstus, kas var būt noderīgi, lai mijiedarbotos ar Cloud VPS produktiem, izmantojot API: