Перейти к основному содержимому
Версия: 8.1

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

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

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

BindConfigItemsToThresholds

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      ThresholdsBindsThresholdsConfigItemsBindPostModel (Array)Массив моделей порога и КЕСвязь
    • Outputs

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

UnbindConfigItemsFromThresholds

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      ThresholdsUnbindsThresholsConfigItemsBindPostModel (Array)Массив моделей порога и КЕСвязь
    • Outputs

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

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

FilterByThresholdRuleId

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      RuleThresholdEventRuleМодель правила, по которому были рассчитаны пороги. Содержит идентификатор, который участвует в фильтрацииСвязь
      RuleIdsInteger64 (array)Список идентификаторов правил, по которым будет производится фильтрацияСвязь
    • Outputs

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

FilterThresholdsExtended

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

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

    • Inputs

      НазваниеТипОписаниеПараметры
      InExecПин вызоваСвязь
      ScenarioStruct:ScenarioBaseСистемная переменнаяСвязь
      BearerTokenStringПо умолчанию BearerToken запрашивается из переменной Scenario, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол
      FieldMaskStringМаска возвращаемых значений. По умолчанию, возвращается только Id. Структура модели ответа остается неизменной.Связь/контрол
      PagingPagingModelМодель постраничного запроса, с возможностью указать дополнительные параметры фильтрацииСвязь
      IdsInteger64 (array)Массив идентификаторов пороговСвязь
      ConfigItemIdsInteger64 (array)Массив КЕ, привязанных к порогуСвязь
      CreatedAtDatePostДата открытия порогаСвязь
      ClosedAtDatePostДата закрытия порогаСвязь
      ConfirmedAtDatePostДата подтверждения порогаСвязь
      StatusesString (array)Статус порога (Opened / Closed)Связь
      LevelsInteger (array)Критичность порога (1-Fatal, 2-Critical, 3-Major, 4-Warning, 5-Info; 0-OK.)Связь
      DurationMillisecondsValueFilterДлительность порога в миллисекундахСвязь
      OwnerWorkGroupIdsInteger64 (array)Идентификатор РГ-владельца порогаСвязь
      HashsString (array)Уникальный хэш метрикиСвязь
      RuleSnapshotIdsInteger64 (array)Идентификатор правила порогаСвязь
      WithoutCIsBooleanПризнак наличия связи с КЕСвязь
      ConfigitemComponentNameStringНазвание компонента КЕСвязь
      ConfigItemComponentsSlotString (array)Названия слотов компонентов КЕСвязь
      FieldMask

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

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

    • Outputs

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

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

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