Функции для работы с Порогами
Описание и характеристика функций модуля Автоматизации, которые можно использовать для привязки порогов к конфигурационным единицам РСМ.
BindConfigItemsToThresholds
Назначение: Привязка КЕ к порогам
Описание: Функция принимает на вход массив моделей порога и списка КЕ, которые необходимо к нему привязать, производит привязку и возвращает массив моделей порогов с привязанными КЕ.
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь Scenario Struct:ScenarioBase Системная переменная Связь 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 Пин вызова Связь Scenario Struct:ScenarioBase Системная переменная Связь 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 Пин вызова Связь Scenario Struct:ScenarioBase Системная переменная Связь 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 Признак наличия связи с КЕ Связь Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь Thresholds Struct:Threshold (Array) Массив моделей порогов, которые были возвращены в результате фильтр-запроса Связь Response Struct:AutomatonResponse Возвращает результат выполнения запроса согласно модели AutomatonResponse Связь
SendMetrics
Назначение: Отправка массива метрик в поток данных
Описание: Функция позволяет отфильтровать события расчетчика порогов по правилу, по которому были рассчитаны пороги.
Inputs
Название Тип Описание Параметры In Exec Пин вызова Связь Scenario Struct:ScenarioBase Системная переменная Связь BearerToken String По умолчанию BearerToken
запрашивается из переменнойScenario
, если указать вручную - в запросе к API будет применен указанныйСвязь/контрол StreamId Metric (array) Массив моделей метрик, которые будут отправлены в поток данных Связь Outputs
Название Тип Описание Параметры Ok Exec Последовательность активна в случае успешного выполнения запроса Связь Failed Exec Последовательность активна если запрос выполнен с ошибкой Связь Result String (array) Итоговое представление метрики, отправляемое в хранилище Связь Response Exec Возвращает результат запроса согласно модели AutomatonResponse Связь
Модель Metric
- Название метрики (string);
- Значение метрики (double);
- Labels - объект с набором меток формата ключ:значение (dynamic)
Если объект будет иметь вложенные объекты, функция вернет ошибку.
- Timestamp - время, которое будет указано в метрике. Если ничего не указывать - будет задано текущее время по UTC