Описание параметров схемы

BasicError

Описание ошибки.

Имя поля Обязательное Тип Описание Пример

code

Да

string

Код ошибки. Включает параметр ErrorCode. Допустимые значения:

  • object_already_exists — объект уже существует;

  • object_not_found — объект не найден;

  • validation_failed — ошибка валидации;

  • authorization_failed — ошибка авторизации;

  • internal_error — внутренняя ошибка

validation_failed

message

Да

String

Сообщение об ошибке

Template contains not resolved variables

ErrorCode

Код ошибки.

Тип: string.

Допустимые значения:

  • object_already_exists — объект уже существует;

  • object_not_found — объект не найден;

  • validation_failed — ошибка валидации;

  • authorization_failed — ошибка авторизации;

  • internal_error — внутренняя ошибка.

SaltScheduleSettingsResponse

Текущие настройки расписаний для SaltStack.

Имя поля Обязательное Тип Описание Пример

seconds

Нет

integer

Определяет временной промежуток в секундах, через который будет выполняться операция. Минимальное значение: 1

3600

minutes

Нет

integer

Определяет временной промежуток в минутах, через который будет выполняться операция. Минимальное значение: 1

60

hours

Нет

integer

Определяет временной промежуток в часах, через который будет выполняться операция. Минимальное значение: 1

24

days

Нет

integer

Определяет временной промежуток в днях, через который будет выполняться операция. Минимальное значение: 1

14

range

Нет

string

Временной интервал от 00:00 до 23:59, в рамках которого будет выполняться операция согласно расписанию. Включает параметры TimeRange:

  • start — начало временного интервала в формате HH:MM (24 часа). Шаблон: ^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$;

  • end — окончание временного интервала в формате HH:MM (24 часа). Шаблон: ^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$

  • 09:00

  • 18:00

splay

Нет

integer

Определяет верхнюю границу случайной задержки перед запланированным выполнением в секундах. Например, если splay=10, ко времени следующего выполнения операции будет добавлен случайный промежуток от 0 до 10 секунд. Минимальное значение: 0. Максимальное значение: 10

5

SaltUpdateScheduleSettingsRequest

Запрос на изменение настроек расписаний для SaltStack.

Имя поля Обязательное Тип Описание Пример

seconds

Нет

integer

Определяет временной промежуток в секундах, через который будет выполняться операция. Минимальное значение: 1

3600

minutes

Нет

integer

Определяет временной промежуток в минутах, через который будет выполняться операция. Минимальное значение: 1

60

hours

Нет

integer

Определяет временной промежуток в часах, через который будет выполняться операция. Минимальное значение: 1

24

days

Нет

integer

Определяет временной промежуток в днях, через который будет выполняться операция. Минимальное значение: 1

14

range

Нет

string

Временной интервал от 00:00 до 23:59, в рамках которого будет выполняться операция согласно расписанию. Включает параметры TimeRange:

  • start — начало временного интервала в формате HH:MM (24 часа). Шаблон: ^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$;

  • end — окончание временного интервала в формате HH:MM (24 часа). Шаблон: ^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$

  • 09:00

  • 18:00

splay

Нет

integer

Определяет верхнюю границу случайной задержки перед запланированным выполнением в секундах. Например, если splay=10, ко времени следующего выполнения операции будет добавлен случайный промежуток от 0 до 10 секунд. Минимальное значение: 0. Максимальное значение: 10

5

createdAt

Да

string

Дата и время создания параметра

2023-08-27T09:37:40.000Z

updatedAt

Да

string

Дата и время последнего обновления параметра

2023-08-27T09:37:40.000Z

updatedBy

Нет

string

Автор последнего изменения параметра

author

SyncSettings

Расписание для синхронизации из источников LDAP.

Имя поля Обязательное Тип Описание Пример

schedule

Да

string

Расписание синхронизации в виде Cron-выражения в формате Quartz. Одно значение для всех источников. Для выключения передается значение off. Минимальная длина: 3. Максимальная длина: 4096

0 0 12 * * ?

TimeRange

Временной интервал от 00:00 до 23:59.

Имя поля Обязательное Тип Описание Пример

start

Да

string

Начало временного интервала в формате HH:MM (24 часа). Шаблон: ^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$

09:00

end

Да

string

Окончание временного интервала в формате HH:MM (24 часа). Шаблон: ^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$

18:00

UserSessionsSettingsResponse

Текущие настройки хранения истории активности пользователей.

Имя поля Обязательное Тип Описание Пример

storageDaysCount

Да

integer

Максимальное количество дней, в течение которых хранятся записи о сессиях. Минимальное значение: 1

1

sessionHistoryCleanupCron

Да

``

Cron-выражение в формате quartz, задающее расписание автоматического удаления истории сессий, которые хранятся более, чем указано в параметре storageDaysCount

example: 0 0 0 */1 * *