Функции для работы с Порогами

Описание и характеристика функций модуля Автоматизации, которые можно использовать для привязки порогов к конфигурационным единицам РСМ.

Функции управления связями порогов

BindConfigItemsToThresholds

• Назначение: Привязка КЕ к порогам

• Описание: Функция принимает на вход массив моделей порога и списка КЕ, которые необходимо к нему привязать, производит привязку и возвращает массив моделей порогов с привязанными КЕ.

  • Inputs

    Название	Тип	Описание	Параметры
    In	Exec	Пин вызова	Связь
    BearerToken	String	По умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
    ThresholdsBinds	ThresholdsConfigItemsBindPostModel (Array)	Массив моделей порога и КЕ	Связь

  • Outputs

    Название	Тип	Описание	Параметры
    Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
    Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
    ThresholdsBindResult	Struct:Automaton.Metrics.ThresholdBindsConfigItemResult (Array)	Возвращает массив привязанных порогов к КЕ	Связь
    Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

---

UnbindConfigItemsFromThresholds

• Назначение: Отвязка КЕ от порогов

• Описание: Функция принимает на вход массив моделей порога и списка КЕ, которые необходимо отвязать от этого порога.

  • Inputs

    Название	Тип	Описание	Параметры
    In	Exec	Пин вызова	Связь
    BearerToken	String	По умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
    ThresholdsUnbinds	ThresholsConfigItemsBindPostModel (Array)	Массив моделей порога и КЕ	Связь

  • Outputs

    Название	Тип	Описание	Параметры
    Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
    Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
    ThresholdsBindResult	Struct:Automaton.Metrics.ThresholdBindsConfigItemResult (Array)	Возвращает массив привязанных порогов к КЕ	Связь
    Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

Функции поиска порогов

FilterByThresholdRuleId

• Назначение: Фильтрация порогов по идентификатору правила, по которому получено событие

• Описание: Функция позволяет отфильтровать события расчетчика порогов по правилу, по которому были рассчитаны пороги.

  • Inputs

    Название	Тип	Описание	Параметры
    In	Exec	Пин вызова	Связь
    Rule	ThresholdEventRule	Модель правила, по которому были рассчитаны пороги. Содержит идентификатор, который участвует в фильтрации	Связь
    RuleIds	Integer64 (array)	Список идентификаторов правил, по которым будет производится фильтрация	Связь

  • Outputs

    Название	Тип	Описание	Параметры
    Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
    Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь

---

FilterThresholdsExtended

• Назначение: Отвязка КЕ от порогов

• Описание: Функция принимает на вход массив моделей порога и списка КЕ, которые необходимо отвязать от этого порога.

  • Inputs

    Название	Тип	Описание	Параметры
    In	Exec	Пин вызова	Связь
    BearerToken	String	По умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанный	Связь/контрол
    FieldMask	String	Маска возвращаемых значений. По умолчанию, возвращается только Id. Структура модели ответа остается неизменной.	Связь/контрол
    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	Признак наличия связи с КЕ	Связь
    ConfigitemComponentName	String	Название компонента КЕ	Связь
    ConfigItemComponentsSlot	String (array)	Названия слотов компонентов КЕ	Связь

    FieldMask

    Представляет собой строку с названиями полей модели, разделёнными запятой.

    Доступные поля:

    • id - идентификатор

    • name - название

    • ownerWorkGroup - владелец

    • status - статус

    • level - уровень

    • createdAt - дата открытия

    • closedAt - дата закрытия

    • confirmedAt - дата подтверждения

    • durationMilliseconds - длительность

    • configItems - связанные КЕ

    • thresholdRuleSnapshot - правило, по которому открыт порог

    Если поле FieldMask не заполнено - будет возвращена полная модель КЕ, со всеми значениями полей.

  • Outputs

    Название	Тип	Описание	Параметры
    Ok	Exec	Последовательность активна в случае успешного выполнения запроса	Связь
    Failed	Exec	Последовательность активна если запрос выполнен с ошибкой	Связь
    Thresholds	Struct:Threshold (Array)	Массив моделей порогов, которые были возвращены в результате фильтр-запроса	Связь
    Response	Struct:AutomatonResponse	Возвращает результат выполнения запроса согласно модели AutomatonResponse	Связь

ConfigitemComponentName - если указано только название компонента (без слота), должны быть найдены все пороги привязанные к компоненту с указанным названием без привязки к КЕ (если не указан Id КЕ)

ConfigItemComponentsSlot - если указано только название слота (без названия компонента), должны быть найдены все пороги со слотом такого же названия, не зависимо от компонента и КЕ (если не указан Id КЕ)