API - Взаємодія з Backup Schedule

Створення розкладу для створення резервної копії

Щоб створити розклад для створення резервної копії, виконайте наступний запит:

URL:

https://api.zomro.com/

Метод: POST

Тіло запиту (Form-data):

Параметр	Приклад значення	Обов'язковий параметр	Опис значення
func	instances.fleio_bckps.schedule.edit	Так	Функція для створення розкладу для створення резервної копії
auth	21fc199...c43f71	Ні	Токен сесії. Це один з варіантів авторизації. Докладніше про інші варіанти описано тут
out	json	Так	Тип відповіді, яку очікувати
sok	ok	Так	Підтвердження операції
plid	5203773	Так	ID instance, для якого створити розклад для створення резервної копії
name	MyBackup	Так	Назва розкладу для створення резервної копії
rotation_days	1,2,3,4,5,6,0	Так	У які дні створювати резервні копії. Початок тижня починається з неділі і має ID - 0. Відповідно понеділок має значення 1. Інші дні тижня - відповідні значення.
rotation_time	02:01	Так	У який час створити резервну копію

Приклад створення розкладу для створення резервної копії для послуги

Для прикладу, використовуємо послугу:

І створимо новий розклад для створення резервної копії з Понеділка по П'ятницю о 02:01

URL:

https://api.zomro.com/

Метод: POST

Тіло запиту (Form-data):

Параметр	Значення
func	instances.fleio_bckps.edit
auth	21fc199...c43f71
out	json
sok	ok
plid	5203773
name	MySchedule
rotation_days	1,2,3,4,5,6
rotation_time	02:01

Ось приклад запиту, який можна виконати з консолі:

curl --location 'https://api.zomro.com/' \
--form 'func="instances.fleio_bckps.schedule.edit"' \
--form 'auth="7e0cb9825a87e4c1a150dc9b"' \
--form 'out="json"' \
--form 'name="MySchedule"' \
--form 'rotation_days="1,2,3,4,5,6"' \
--form 'rotation_time="02:01"' \
--form 'plid="5203773"' \
--form 'sok="ok"'

Після виконання запиту бачимо, що новий розклад для створення резервної копії створено успішно:

Також, за допомогою API, є можливість отримати список всіх створених розкладів для створення резервних копій. Для цього виконуємо наступний формат запиту:

URL:

https://api.zomro.com/

Метод: POST

Тіло запиту (Form-data):

Параметр	Приклад значення	Обов'язковий параметр	Опис значення
func	instances.fleio_bckps.schedule	Так
auth	21fc199...c43f71	Ні	Токен сесії. Це один з варіантів авторизації. Докладніше про інші варіанти описано тут
out	json	Так	Тип відповіді, яку очікувати
plid	5203773	Так	ID instance, резервні копії якої планується отримати

Для прикладу, спробуємо отримати розклад для створення резервних копій для послуги 5203773. На попередньому кроці створили розклад для створення резервної копії. Спробуємо отримати її.

Спробуємо виконати наступний запит в консолі:

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

Отримуємо наступний результат:

{
    "doc": {
        ...
        "elem": [
            {
                "create_date": {
                    "$": "2024-07-24"
                },
                "id": {
                    "$": "14"
                },
                "instance_id": {
                    "$": "5203773"
                },
                "name": {
                    "$": "MySchedule"
                },
                "rotation_days": {
                    "$": "Monday Tuesday Wednesday Thursday Friday Saturday "
                },
                "rotation_time": {
                    "$": "02:01"
                },
                "servername": {
                    "$": "MyServer"
                }
            }
        ],
    }
}

Нас цікавлять дані, які отримані в наступній вкладеності:

doc.elem.[]

З цієї відповіді ми отримуємо наступні дані:

Назва поля	Опис
create_date	Час створення розкладу для створення резервної копії
id	ID резервної копії в межах bill manager
instance_id	ID instance в межах bill manager
name	Назва резервної копії
rotation_days	Дні, коли створюється резервна копія
rotation_time	Час, коли буде створена резервна копія
servername	Назва сервера.

Для видалення резервної копії виконуємо наступний запит:

URL:

https://api.zomro.com/

Метод: POST

Тіло запиту (Form-data):

Параметр	Приклад значення	Обов'язковий параметр	Опис значення
func	image.delete	Так	Функція для видалення розкладу для створення резервної копії
auth	21fc199...c43f71	Ні	Токен сесії. Це один з варіантів авторизації. Докладніше про інші варіанти описано тут
out	json	Так	Тип відповіді, яку очікувати
elid	14	Так	ID розкладу, який необхідно видалити

Спробуємо виконати наступний запит в консолі:

curl --location 'https://api.zomro.com/' \
--form 'func="instances.fleio_bckps.schedule.delete"' \
--form 'auth="7c70d43c92c610c4c6c42c2c"' \
--form 'out="json"' \
--form 'elid="14"'

Після виконання запиту, перевірити результат, переглянувши за допомогою веб інтерфейсу:

Як можемо побачити, розклад для створення резервної копії було успішно видалено.

Також пропонуємо вивчити статті, які можуть бути корисними для взаємодії з продуктами Cloud VPS за допомогою API: