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

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

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

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Признак наличия связи с КЕСвязь
    • Outputs

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

SendMetrics

  • Назначение: Отправка массива метрик в поток данных

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

    • Inputs

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

      НазваниеТипОписаниеПараметры
      OkExecПоследовательность активна в случае успешного выполнения запросаСвязь
      FailedExecПоследовательность активна если запрос выполнен с ошибкойСвязь
      ResultString (array)Итоговое представление метрики, отправляемое в хранилищеСвязь
      ResponseExecВозвращает результат запроса согласно модели AutomatonResponseСвязь

Модель Metric

  • Название метрики (string);
  • Значение метрики (double);
  • Labels - объект с набором меток формата ключ:значение (dynamic)

    Если объект будет иметь вложенные объекты, функция вернет ошибку.

  • Timestamp - время, которое будет указано в метрике. Если ничего не указывать - будет задано текущее время по UTC