Поиск параметров профилей подходящих версии агента

Запрос

Тип	Метод
`POST`	`/agents/params_meta/search`

Описание: При выполнении запроса будут возвращены параметры профилей сбора, соответствующих указанной версии агента сбора, с учётом заданных фильтров.

Пример запроса


POST
https://127.0.0.1:9000/cm/api/v2/agents/params_meta/search

Тело запроса:

Параметр	Тип данных	Обязательность	Описание
include_fields	`Array<string>`	Required	Список полей для выборки. Если модель содержит поля, не указанные в запросе, они будут отсутствовать в ответе
exclude_fields	`Array<string>`	Required	Список полей для удаления из выборки. Если модель содержит поля, указанные в запросе, они будут отсутствовать в ответе
filters	`Array`<filters>	Required	Список фильтров по полям модели
ordering	`Array`<ordering>	Required	Настройки сортировки
virtual_search	`object`<virtual_search>	Required	Поле для поиска по подстроке по всем строковым полям модели и настройка строгого поиска
relations	`Array<string>`	Required	Список связей для выборки. Список доступных связей отображается в ответе запроса на получение метаданных - `“/_meta”`
limit	`integer`	Required	Лимит выдачи найденных объектов
offset	`integer`	Required	Отступ от начала результата поиска в базе
_relations	`Array<string>`	Optional	Перечисление связанных сущностей идентификаторы которых нужно вернуть в ответе в поле `_relations`
extension_params	`object`<Extension_params>	Optional	Фильтрация по версии

Array of filters

Параметр	Тип данных	Обязательность	Описание
field	`string`	Required	Название поля модели
value	`object`	Required	Значение для фильтрации
filter_type	`string`	Required	В зависимости от этого значения определяется допустимые значения в поле `value`. Допустимые значения: - equal -> строка\|число, проверяет равенство значений - substr -> строка, проверяет вхождение подстроки - intersection -> массив (тип элемента зависит от типа поля), проверяет вхождение значения поля в переданный массив - range -> массив (тип элемента зависит от типа поля), проверяет вхождение значения поля в переданный диапазон - related -> строка или массив строк (uuid), проверят связанность с моделью по идентификатору если `value: []`, проверяет наличие или отсутствие связанных сущностей - exists -> значение отсутствует, проверяется равенство колонки с null
negation	`boolean`	Optional	Флаг использования отрицания при проверке фильтра

Array of ordering

Параметр	Тип	Обязательность	Описание / Допустимые значения
field	`string`	Required	Поле модели выбранное для сортировки
direction	`string`	Required	Направление сортировки. Допустимые значения: - asc - desc

Object VirtualSearch

Параметр	Тип	Обязательность	Описание / Допустимые значения
value	`string`	Required	Значение выбранное для поиска
strict	`boolean`	Required	Опция, включающая строгий поиск. Возможные значения: - `true` - строгий поиск включена; - `false` - строгий поиск выключен.

Extension_params

Один из:

Параметр	Тип	Обязательность	Описание / Допустимые значения
или version	`string`	Required	Фильтрация по версии агента. Будут возвращены только параметры подходящие данной версии
или version_gte	`string`	Required	Фильтрация по типу “больше или равно”. Будут возвращены параметры, подходящие данной версии или более новым.

Пример тела запроса


{
  "include_fields": [
    "string"
  ],
  "exclude_fields": [
    "string"
  ],
  "filters": [
    {
      "field": "string",
      "value": [
        "name",
        [
          "value1",
          "value2"
        ]
      ],
      "filter_type": "equal",
      "negation": false,
      "extension_params": {
        "children_all": true,
        "parents_all": true
      }
    }
  ],
  "ordering": [
    {
      "field": "string",
      "direction": "asc"
    }
  ],
  "virtual_search": {
    "value": "string",
    "strict": false
  },
  "extension_params": {
    "chidlrens_all": true,
    "parents_all": true,
    "version": "3.7.0.5"
  },
  "relations": [
    "service_asset_findings",
    "logmule_go_rules",
    "user"
  ],
  "limit": 20,
  "offset": 0,
  "_relations": [
    "string"
  ]
}

Успешный ответ

Статус код: 200 – успешный ответ.

Формат: JSON.

Параметры ответа:

Параметр	Тип данных	Описание
items	`Array`<AgentParamMeta>	Список найденных параметров профилей сбора.
total	`integer`	Количество найденных записей

Пример ответа


{
  "items": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created_at": "2023-12-20T00:00:01.652259Z",
      "updated_at": "2023-12-20T00:00:01.652259Z",
      "ModuleName": "string",
      "Name": "config.controller.cm_url",
      "Type": "boolean",
      "UI": {
        "Format": "ip",
        "Title": "Адрес Кластер-Менеджера",
        "Description": "string",
        "AcceptedValues": [
          {
            "m": "массив"
          },
          {
            "d": "допустимых"
          },
          {
            "z": "значений"
          }
        ],
        "MinValue": 1024,
        "MaxValue": 65535,
        "Example": "https://172.30.254.70:9000/cm/api/agent/",
        "Group": true
      },
      "ReadOnly": true,
      "MinVersion": "1.1.1",
      "MaxVersion": "1.5.1",
      "Required": true,
      "DefaultValue": "https://172.30.254.70:9000/cm",
      "DefaultValueWindows": "https://172.30.254.70:9000/cm"
    }
  ],
  "total": 1
}

Другие возможные ответы

Код	Ответ	Описание
`400`	`Bad Request`	Неверный тип параметра запроса, либо отсутствует обязательный параметр
`401`	`no auth header`	Не передан заголовок авторизации (`PgrApiKey` или `Authorization`)
`500`	`Internal Server Error`	Другие ошибки сервера

Примечание: Текст ошибки не фиксированный, может изменяться в зависимости от фактического ответа получателя запроса.

Пример ответа

Код 400


{
  "error": "Bad Request",
  "error_code": 400
}

Код 401


{
  "error": "no auth header"
  "error_code": 401
}

Код 500


{
  "error": "Internal Server Error",
  "error_code": 500
}