Пулы

1. Получение списка пулов (GET /pools)

200 OK

Получен список существующих пулов.

2. Получение информации о пуле (GET /pools/{pool_id})

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

200 OK

Получена информация о пуле.

3. Добавление пула (POST /pools)

Набор параметров, которые необходимо передать, зависит от типа пула. В случае, если переданы лишние параметры (которые не подходят создаваемому типу пула), то такие параметры игнорируются.

Параметр compression_type не нужно указывать для пулов типа Block device и Client defined.

Параметры block_size, hash_length, algorithm, meta_data_pool указываются только для пулов типа Block device.

Параметр archive_part_size указывается только для пулов типа Cloud.

{
  "pool_name": "my_pool_name", (1)
  "pool_type": "Block device", (1)
  "media_server": "rubackup-server", (1)
  "compression_type": "None",
  "description": "",
  "retention_period": "1 year",
  "ignore_free_space_check": false,
  "archive_part_size": 1,
  "meta_data_pool": "Default",
  "algorithm": "streebog",
  "block_size": 131072,
  "hash_length": 256
}
1 Обязательное поле
201 CREATED

Пул создан.

4. Редактирование пула (PATCH /pools/{pool_id})

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

Набор параметров, которые необходимо передать, зависит от типа пула. В случае, если переданы лишние параметры (которые не подходят создаваемому типу пула), то такие параметры игнорируются.

Параметр compression_type не нужно указывать для пулов типа Block device и Client defined.

Параметры meta_data_pool, move_old_metadata указываются только для пулов типа Block device.

Параметр archive_part_size указывается только для пулов типа Cloud.

{
  "pool_name": "my_pool_name",
  "compression_type": "None",
  "description": "",
  "retention_period": "1 year",
  "ignore_free_space_check": false,
  "archive_part_size": 1,
  "meta_data_pool": "Default",
  "move_old_metadata": false
}
200 OK

Параметры пула изменены.

400 BAD_REQUEST

Некорректное тело запроса.

404 NOT_FOUND

Пул не найден.

5. Удаление списка пулов (DELETE /pools)

{
  "ids": [ (1)
    1
  ]
}
1 Обязательное поле
204 NO_CONTENT

Пулы удалены.

207 MULTI_STATUS

Часть пулов удалена.

404 NOT_FOUND

Пул не найден.

6. Получение списка пулов, доступных для перемещения и копирования (GET /pools/destination_available)

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

Также в query-параметрах передается действие copy или move.

200 OK

Получен список доступных для перемещения и копирования пулов.