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: