В этом разделе

Правила глобального расписания

1. Изменение статуса правила глобального расписания (PATCH `/global_schedule`)

{
  "data": [
    {
      "id": 1, (1)
      "status": "wait" (1)
    }
  ]
}

1	Обязательное поле

200 OK: Статус правила изменен
400 BAD_REQUEST: Некорректное тело запроса
404 NOT_FOUND: Правило глобального расписания не найдено

2. Получение списка правил глобального расписания (GET `/global_schedule`)

200 OK: Параметры правила глобального расписания получены

3. Удаление списка правил глобального расписания (DELETE `/global_schedule`)

{
  "ids": [ (1)
    1
  ]
}

1	Обязательное поле

200 OK: Правило глобального расписания удалено

4. Добавление правила глобального расписания (POST `/global_schedule`)

{
  "data": {
    "global_schedule": {
      "name": "global_schedule_name", (1)
      "client_id": "rubackup-client (525a99154f3505a2)", (1)
      "resource_type": "File system", (1)
      "resource": "/home/", (1)
      "backup_type": "full",
      "pool_id": "Default",
      "storage_capacity": 10,
      "priority": 100,
      "crypto": "nocrypt",
      "validity_start_period": "2024-09-02T15:40:01.208623",
      "validity_end_period": "2025-09-02T15:40:01.208636",
      "periodic_launch": "1 min",
      "min": 0,
      "hour": 0,
      "dom": 1,
      "mon": 1,
      "dow": 1,
      "verify_flag": true,
      "verify_interval": "1 day",
      "storage_duration": "1 day",
      "move_copy_flag": false,
      "move_copy_pool": "Default",
      "move_copy_while": "1 day",
      "auto_delete_obsoleted_copy_flag": false,
      "inform_when_obsoleted_copy": "Nobody",
      "client_delete_flag": true,
      "notify_normal": "Nobody",
      "notify_normal_cc": "email@http://domain.ru[domain.ru]",
      "notify_exception": "Nobody",
      "notify_exception_cc": "email@http://domain.ru[domain.ru]",
      "notify_rule_validity": "Nobody",
      "notify_rule_validity_cc": "email@http://domain.ru[domain.ru]",
      "notify_verify": "Nobody",
      "notify_verify_cc": "email@http://domain.ru[domain.ru]",
      "status": "wait",
      "notify_normal_script": "",
      "notify_exception_script": "",
      "notify_end_storage_capacity": "Nobody",
      "notify_end_storage_capacity_cc": "email@http://domain.ru[domain.ru]",
      "restore_script": ""
    },
    "module_extensions": {
      "parameters": {
        "file_list": true,
        "numeric_owner": false,
        "use_snapshot": false,
        "ignore_errors_snapshot": true,
        "snapshot_type": "",
        "snapshot_size": 10,
        "script_before_snapshot": "",
        "script_after_snapshot": "",
        "script_error_snapshot": ""
      }
    },
    "common_modules_extensions": {
      "parameters": {
        "worker_parallelism": 8,
        "enable_multithreading": false,
        "enable_flexible_dedup": false,
        "network_parallelism": 8,
        "memory_threshold": 0,
        "deny_memory_exceed": false
      }
    }
  }
}

1	Обязательное поле

201 CREATED: Правило глобального расписания создано

5. Получение дополнительных параметров глобального расписания по `id` правила (GET `/global_schedule/extension`)

Тело запроса отсутствует. В query-параметрах передается название ресурса (resource_type) или название ресурса и id правила, информацию о дополнительных параметрах которых необходимо получить

200 OK: Информация о дополнительных параметрах получена

6. Изменение правила глобального расписания (PATCH `/global_schedule/{id}`)

Также в query-параметрах передается id правила, информацию о котором необходимо изменить

{
  "data": {
    "global_schedule": {
      "name": "global_schedule_name",
      "pool_id": "Default",
      "storage_capacity": 10,
      "priority": 100,
      "validity_start_period": "2024-09-02T15:40:01.208623",
      "validity_end_period": "2025-09-02T15:40:01.208636",
      "periodic_launch": "1 min",
      "min": 0,
      "hour": 0,
      "dom": 1,
      "mon": 1,
      "dow": 1,
      "verify_flag": true,
      "verify_interval": "1 day",
      "storage_duration": "1 day",
      "move_copy_flag": false,
      "move_copy_pool": "Default",
      "move_copy_while": "1 day",
      "auto_delete_obsoleted_copy_flag": false,
      "inform_when_obsoleted_copy": "Nobody",
      "client_delete_flag": true,
      "notify_normal": "Nobody",
      "notify_normal_cc": "email@http://domain.ru[domain.ru]",
      "notify_exception": "Nobody",
      "notify_exception_cc": "email@http://domain.ru[domain.ru]",
      "notify_rule_validity": "Nobody",
      "notify_rule_validity_cc": "email@http://domain.ru[domain.ru]",
      "notify_verify": "Nobody",
      "notify_verify_cc": "email@http://domain.ru[domain.ru]",
      "status": "wait",
      "notify_normal_script": "",
      "notify_exception_script": "",
      "notify_end_storage_capacity": "Nobody",
      "notify_end_storage_capacity_cc": "email@http://domain.ru[domain.ru]",
      "restore_script": ""
    },
    "module_extensions": {
      "parameters": {
        "file_list": true,
        "numeric_owner": false,
        "use_snapshot": false,
        "ignore_errors_snapshot": true,
        "snapshot_type": "",
        "snapshot_size": 10,
        "script_before_snapshot": "",
        "script_after_snapshot": "",
        "script_error_snapshot": ""
      }
    },
    "common_modules_extensions": {
      "parameters": {
        "worker_parallelism": 8,
        "enable_multithreading": false,
        "enable_flexible_dedup": false,
        "network_parallelism": 8,
        "memory_threshold": 0,
        "deny_memory_exceed": false
      }
    }
  }
}

200 OK: Параметры правила глобального расписания изменены
400 BAD_REQUEST: Некорректное тело запроса
404 NOT_FOUND: Правило глобального расписания не найдено

7. Получение информации о правиле глобального расписания (GET `/global_schedule/{id}`)

Тело запроса отсутствует. В query-параметрах передается id правила, информацию о котором необходимо получить

200 OK: Информация о правиле глобального расписания получена
404 NOT_FOUND: Правило глобального расписания не найдено

8. Удаление правила глобального расписания (DELETE `/global_schedule/{id}`)

Тело запроса отсутствует. В query-параметрах передается id правила, которое необходимо удалить

200 OK: Правило глобального расписания удалено
404 NOT_FOUND: Правило глобального расписания не найдено

9. Создание полной резервной копии по правилу глобального расписания (POST `/global_schedule/{id}/execution`)

Тело запроса отсутствует. В query-параметрах передается id правила, которое необходимо выполнить ("принудительно")

200 OK: Правило глобального расписания выполнено
404 NOT_FOUND: Правило глобального расписания не найдено