Секция schema
Подтипы тарифной опции integer:
-
Константа (рисунок 1).
Рисунок 1 — Тарифная опция-константа типа integer -
С выбором значения из списка (рисунок 2).
Рисунок 2 — Тарифная опция типа integer c выбором значения из списка -
С шагом изменения (рисунок 3 и рисунок 4).
По умолчанию шаг изменения опции равен
1. Изменить размер шага, сделать его платным можно в секции billing.
Рисунок 3 — Тарифная опция типа integer с шагом изменения
Рисунок 4 — Тарифная опция типа integer с шагом изменения, значение увеличено на шаг изменения
Параметры для тарифной опции типа integer приведены в таблице 1.
Имя | Описание | Формат | Обязательный |
|---|---|---|---|
Основные параметры тарифной опции, одинаковые для всех подтипов | |||
description | Имя тарифной опции | string, до 255 символов | Да |
hint | Подсказка с описанием тарифной опции | string, до 255 символов | Нет |
type | Определяет тип тарифной опции. Укажите значение | — | Да |
Параметры, чтобы настроить подтип тарифной опции | |||
Параметр для опции-константы | |||
const | Определяет значение тарифной опции-константы | integer | Да |
Параметры для опции с выбором значения | |||
enum | Определяет список значений, среди которых пользователь сможет выбрать одно | Список, внутри списка — integer | Да |
default | Определяет значение тарифной опции по умолчанию | integer | Да |
Параметры для опции c шагом изменения 1 | |||
default | Определяет значение тарифной опции по умолчанию. Если параметр не задан, значение по умолчанию равно | integer, >= 0 или | Нет |
minimum | Определяет минимальное значение тарифной опции | integer, >= 0 и ⇐ | Нет |
maximum | Определяет максимальное значение тарифной опции | integer, > 0 и >= | Нет |
tag | Тег. Позволяет связать несколько опций между собой. Используется, чтобы описать диск (подробнее — в подразделе billing) | string | Нет |
Параметры для опции c пользовательским шагом изменения. Шаг изменения настраивается в секции billing | |||
default | Определяет значение тарифной опции по умолчанию, рассчитанное относительно стандартного значения (стандартное значение задаётся в параметре
| integer, >= 0 или | Нет |
minimum | Определяет минимальное значение тарифной опции, рассчитанное относительно стандартного значения (стандартное значение задаётся в параметре
| integer, >= 0 и ⇐ | Нет |
maximum | Определяет максимальное значение тарифной опции, рассчитанное относительно стандартного значения (стандартное значение задаётся в параметре
| integer, > 0 и >= | Нет |
Подтипы тарифной опции string:
-
Константа (рисунок 5).
Рисунок 5 — Тарифная опция-константа типа string -
С вводом значения (рисунок 6).
Рисунок 6 — Тарифная опция типа string c вводом значения -
С выбором значения из списка (рисунок 7).
Рисунок 7 — Тарифная опция типа string c выбором значения из списка
Параметры для тарифной опции типа string приведены в таблице 2.
Имя | Описание | Формат | Обязательный |
|---|---|---|---|
Основные параметры тарифной опции, одинаковые для всех подтипов | |||
description | Имя тарифной опции | string, до 255 символов | Да |
hint | Подсказка с описанием тарифной опции | string, до 255 символов | Нет |
type | Определяет тип тарифной опции. Укажите значение | — | Да |
Параметры, чтобы настроить подтип тарифной опции | |||
Параметр для опции-константы | |||
const | Определяет значение тарифной опции-константы | string | Да |
Параметры для опции c вводом значения | |||
default | Определяет значение по умолчанию | string | Нет |
pattern | Определяет шаблон, которому должно соответствовать значение тарифной опции | regex | Нет |
minLength | Определяет минимальное количество символов для значения тарифной опции | integer, > 0 и ⇐ | Нет |
maxLength | Определяет максимальное количество символов для значения тарифной опции | integer, > 0 и >= | Нет |
Параметры для опции с выбором значения из списка | |||
enum | Определяет список значений, среди которых пользователь сможет выбрать одно | Список, внутри списка — string | Да |
default | Определяет значение по умолчанию | string | Да |
Подтип тарифной опции boolean:
-
Константа (рисунок 8).
Рисунок 8 — Тарифная опция-константа типа boolean -
Переключатель (рисунок 9).
Рисунок 9 — Переключатель boolean
Параметры для тарифной опции типа boolean приведены в таблице 3.
Имя | Описание | Формат | Обязательный |
|---|---|---|---|
Основные параметры тарифной опции, одинаковые для всех подтипов | |||
description | Имя тарифной опции | string, до 255 символов | Да |
hint | Подсказка с описанием тарифной опции | string, до 255 символов | Нет |
type | Определяет тип тарифной опции. Укажите значение | — | Да |
Параметры, чтобы настроить подтип тарифной опции | |||
Параметр для опции-константы | |||
const | Определяет значение тарифной опции-константы | boolean | Да |
Параметр для опции-переключателя | |||
default | Определяет значение тарифной опции по умолчанию. | boolean | Нет |
Параметры для тарифной опции типа datasource приведены в таблице 4.
Имя | Описание | Формат | Обязательный |
|---|---|---|---|
description | Имя тарифной опции | string, до 255 символов | Да |
hint | Подсказка с описанием тарифной опции | string, до 255 символов | Нет |
type | Совместно с секцией Укажите значение | — | Да |
default | Определяет значение по умолчанию. Может быть задан только для типа Возможные значения для
| — | Нет |
tag | Тег. Позволяет связать несколько опций между собой. Используется, чтобы описать диск (подробнее — в подразделе Описание диска с помощью файлов тарифных опций) | string | Нет |
datasource | Секция, которая совместно с параметром Секция описывает конкретный тип сущности Платформы | — | Да |
Параметры секции | |||
datasource.type | Параметр, определяющий тип сущности Платформы. Возможные значения:
Пользователю будет отображаться список значений, соответствующий указанному типу с учётом фильтров (фильтры задаются в секции | — | Да |
datasource.filter | Секция может быть задана только для типов
Определяет фильтры для типа ВМ или диска | — | Нет |
Фильтры для типа ВМ | |||
datasource.filter.vcpus | Определяет фильтры для CPU ВМ | Приведён в таблице таблице 5 | Нет |
datasource.filter.ram | Определяет фильтры для RAM ВМ | Приведён в таблице таблице 5 | Нет |
Фильтры для типа диска | |||
datasource.filter.name.enum | Определяет фильтры по имени диска. Возможные значения:
Доступные типы дисков зависят от конкретной инсталляции Платформы. При необходимости уточните имена дисков у администратора Платформы | Список | Нет |
Ограничения по CPU и RAM для ВМ задаются с помощью параметров, приведённых в таблице 5.
Имя | Описание | Формат | Обязательный |
|---|---|---|---|
minimum | Определяет минимальное значение для CPU или RAM — в зависимости от того, в какой секции этот параметр задан. Для RAM значение указывается в МБ | integer, > 0 и <= | Нет |
maximum | Определяет максимальное значение для CPU или RAM — в зависимости от того, в какой секции этот параметр задан | integer, > 0 и >= | Нет |