Отправка запросов

1. Отправка запросов в браузере

Для отправки запроса на создание срочной резервной копии в браузере необходимо выполнить следующие действия:

Перейдите по адресу https://<app_host>:<app_port>/api/v1/ (Рисунок 1):

Рисунок 1. Внешний вид интерактивной документации Swagger

Перейдите к разделу Task queue и выберите метод POST (Рисунок 2):

Рисунок 2. Метод /task_queue

Нажмите кнопку «Try it out». Заполните обязательные поля тела запроса, например (для создания копии файлового ресурса):

{
  "data": {
    "task": {
      "resource_type": "File system",
      "resource": "<имя ресурса>",
      "client": "<client hostname> (<client HW ID>)",
      "backup_type": "full",
      "pool": "<имя пула>",
      "crypto": "nocrypt",
      "priority": 100,
      "storage_duration": "1 Years",
      "archiving": false
    }
  }
}

Нажмите «Execute» (Рисунок 3):

Рисунок 3. Кнопка Execute

В результате должен быть получен статус-код 201 CREATED и ответ с информацией о том, что задача добавлена в очередь (Рисунок 4):

Рисунок 4. Успешный ответ сервера

Для отслеживания статуса выполнения задачи можно использовать метод GET /task_queue.

2. Отправка запросов в терминале

Для того, чтобы отправить запрос на сервер, используя терминал, необходимо отправить запрос с помощью консольной утилиты curl или любым другим удобным способом. В данном примере используется curl. В запросе необходимо передать полученные ранее любым удобным способом csrf-token и access-token.

Для того, чтобы отправить запрос на создание срочной резервной копии файлового ресурса, необходимо выполнить:

curl --location 'https:/<app_host>:<app_port>/api/v1/task_queue/' \
--header 'Content-Type: application/json' \
--header 'X-CSRF-TOKEN: <полученный при авторизации csrf-token>' \
--header 'Authorization: Bearer <полученный при авторизации access-token>' \
--data '{
  "data": {
    "task": {
      "client": "<client hostname> (<client HW ID>)",
      "resource": "<имя ресурса>",
      "resource_type": "File system",
      "backup_type": "full",
      "pool": "<имя пула>",
      "crypto": "nocrypt",
      "priority": 100,
      "storage_duration": "1 Years",
      "archiving": false
    }
  }
}'

После отправки данного запроса должен быть получен ответ с информацией о том, что задача добавлена в очередь:

{
  "is_error": false,
  "message": "Resource with name 'Task Queue' was created successfully! TASK WAS ADDED TO QUEUE: <номер в очереди>",
  "data": {},
  "errors": {}
}