Функции для работы с Порогами
Описание и характеристика функций модуля Автоматизации, которые можно использовать для привязки порогов к конфигурационным единицам РСМ.
Общие параметры для функций
Входящие пины
- In
Тип:exec
Описание: Пин вызова функции и передачи в нее управления - BearerToken
По умолчаниюBearerTokenзапрашивается из системной переменнойScenario.
Если указать вручную, в запросе к API будет применен указанный токен.
Исходящие пины
- Ok
Тип:exec
Описание: Последовательность продолжается по этой ветке в случае успешного выполнения запроса - Failed
Тип:exec
Описание: Последовательность продолжается по этой ветке если запрос выполнен с ошибкой - Response
Тип:Struct:AutomatonResponse
Описание: Возвращает результат выполнения запроса в виде данных со структурой моделиAutomatonResponse
Функции управления связями порогов
BindConfigItemsToThresholds
Назначение: Привязка КЕ к порогам
Описание: Функция принимает на вход массив моделей порога и списка КЕ, которые необходимо к нему привязать, производит привязку и возвращает массив моделей порогов с привязанными КЕ.
Inputs
| Название | Тип | Описание |
|---|---|---|
| In, BearerToken | Общие параметры для функций | |
| ThresholdsBinds | ThresholdsConfigItemsBindPostModel (Array) | Массив моделей порога и КЕ |
Outputs
| Название | Тип | Описание |
|---|---|---|
| Ok, Failed, Response | Общие параметры для функций | |
| ThresholdsBindResult | Struct:Automaton.Metrics.ThresholdBindsConfigItemResult (Array) | Возвращает массив привязанных порогов к КЕ |
UnbindConfigItemsFromThresholds
Назначение: Отвязка КЕ от порогов
Описание: Функция принимает на вход массив моделей порога и списка КЕ, которые необходимо отвязать от этого порога.
Inputs
| Название | Тип | Описание |
|---|---|---|
| In, BearerToken | Общие параметры для функций | |
| ThresholdsUnbinds | ThresholUnbindConfigItemsDeleteModel (Array) | Массив моделей порога и КЕ |
Outputs
| Название | Тип | Описание |
|---|---|---|
| Ok, Failed, Response | Общие параметры для функций | |
| ThresholdsBindResult | Struct:Automaton.Metrics.ThresholdBindsConfigItemResult (Array) | Возвращает массив привязанных порогов к КЕ |
Функции поиска порогов
FilterByThresholdRuleId
Назначение: Фильтрация порогов по id правила
Описание: Функция позволяет отфильтровать события расчетчика порогов по id правила, по которому были рассчитаны пороги.
Inputs
| Название | Тип | Описание |
|---|---|---|
| In | Общие параметры для функций | |
| Rule | ThresholdEventRule | Модель правила, по которому были рассчитаны пороги. Содержит идентификатор, который участвует в фильтрации |
| RuleIds | Integer64 (array) | Список идентификаторов правил, по которым будет производится фильтрация |
Outputs
| Название | Тип | Описание |
|---|---|---|
| Ok, Failed | Общие параметры для функций |
FilterThresholdsExtended
Назначение: Поиск порогов по фильтру
Описание: Функция возвращает массив моделей порогов, попадающих под условия фильтра.
Есть несколько структур, которые требуют обязательного заполнения. Если фильтрация по ним не предполагается, необходимо передать значение Null с помощью функции ReturnNull.
Список обязательных пинов: CreateAt, ClosedAt, ConfirmedAt и DurationMilliseconds
Inputs
| Название | Тип | Описание |
|---|---|---|
| In, BearerToken | Общие параметры для функций | |
| FieldMask | String | Маска возвращаемых значений (см. подсказку ниже) |
| Paging | PagingModel | Модель постраничного запроса, с возможностью указать дополнительные параметры фильтрации |
| Ids | Integer64 (array) | Массив идентификаторов порогов |
| ConfigItemIds | Integer64 (array) | Массив КЕ, привязанных к порогу |
| CreatedAt | DatePost | Дата открытия порога |
| ClosedAt | DatePost | Дата закрытия порога |
| ConfirmedAt | DatePost | Дата подтверждения порога |
| Statuses | String (array) | Статус порога: Opened / Closed |
| Levels | Integer (array) | Критичность порога: 1-Fatal, 2-Critical, 3-Major, 4-Warning, 5-Info, 0-OK |
| DurationMilliseconds | ValueFilter | Длительность порога в миллисекундах |
| OwnerWorkGroupIds | Integer64 (array) | Идентификаторы РГ-владельцев порогов |
| Hashs | String (array) | Уникальный хеш метрики |
| RuleSnapshotIds | Integer64 (array) | Идентификатор правила порога |
| WithoutCIs | Boolean | Признак наличия связи с КЕ |
| ConfigitemComponentNames | String (array) | Названия компонентов КЕ КЕ |
| ConfigItemComponentSlots | String (array) | Названия слотов компонентов КЕ |
Позволяет облегчить запрос к API путем указания только нужных полей в ответе.
Представляет собой строку с названиями полей, разделяемые запятой, например: id,name,configItems.
Значения полей указываются в camelCase и являются регистрозависимыми.
Структура модели ответа остается неизменной.
Если поле FieldMask не заполнено, будет возвращена полная модель порогов, со всеми значениями полей.
Если пин не подключен и не настроен, в результ будет выведено не более 1000 порогов. Чтобы получить все результаты, в пин Paging → PerPage необходимо указать -1
ConfigitemComponentNames - если указано только название компонента (без слота), должны быть найдены все привязанные к компоненту пороги с указанным названием без привязки к КЕ (если не указан id КЕ)
ConfigItemComponentSlots - если указано только название слота (без названия компонента), должны быть найдены все пороги со слотом такого же названия, не зависимо от компонента и КЕ (если не указан id КЕ)
Outputs
| Название | Тип | Описание |
|---|---|---|
| Ok, Failed, Response | Общие параметры для функций | |
| Thresholds | Struct:Threshold (Array) | Массив моделей порогов, которые были возвращены в результате фильтр-запроса |