Поиск объектов

Поиск объектов по заданным критериям поиска.

Запрос

HTTP Запрос

POST /node/api/objects/search

Права

run-bulks

Параметры пути

Параметры не требуются.

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

Можно использовать любое поле в модели Объект как критерий поиска.

Параметр	Тип	Описание
search	Object	Критерий поиска.
options	Object	Дополнительные настройки запроса
options.includeClientData	Boolean	true чтобы включить данные клиента в тело ответа. По умолчанию – false.
options.withHidden	Boolean	true чтобы включить скрытые объекты в тело ответа. По умолчанию – false.

Также, можно использовать модификаторы для уточнения критерия.

$in

Параметр $in позволяет указывать массив точных значений. Объекты, указанное поле которых равно одному из перечисленных значений включается в тело ответа.

{
    "search": {
        "id": {
            "$in": [
                '639895add8f7281a28794ea4',
                '639895b9d8f7281a28794eea'
            ]
        }
    }
}

Сравнение числовых полей

Можно использовать следующие параметры для сравнения числовых полей:

• $gt — больше чем;
• $lt — меньше чем;
• $gte — больше или равно;
• $lte — меньше или равно.

{
    "search": {
        "updated": {
            "$gte": 1670234676700
        }
    }
}

Регулярные выражения

Используйте регулярные выражения, чтобы фильтровать объекты по их текстовым полям.

{
    "search": {
        "name": {
            "$regex": "cpu",
            "$options": "i"
        }
    }
}

Можно указать следующие настройки регулярных выражений в поле $options:

Options	Descriptions
i	Игнорировать регистр.

Свойства

Используйте модификатор $elemMatch чтобы искать по определённым параметрам или свойствам. Все возможные поля можно увидеть в модели Свойства.

{
    "search": {
        "properties": {
            "$elemMatch": {
                "type_id": 8
            }
        }
    }
}

Тело запроса

{
    "search": {
        <search criterion 1>,
        ...
        <search criterion n>
    },
    "options":{
        "includeClientData": true
    }
}

Ответ

Этот запрос возвращает массив объектов, которые подходят под заданный критерий поиска. Подробная информация о модели доступна в статье Объект.

Пример

Запрос

Следующий пример демонстрирует поиск по имени объекта с учётом регистра. Этот запрос вернёт все объекты с именем "CPU" в системе.

• Bash
• JavaScript
• NodeJS
• Python

login=<...>
password=<...>
saymon_hostname=<...>
url=https://$saymon_hostname/node/api/objects/search

curl -X POST $url -u $login:$password \
    -H "Content-Type: application/json" \
    -d @- <<EOF
{
    "search": {
        "name": {
            "$regex": "cpu",
            "$options": "i"
        }
    }
}
EOF

let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/objects/search";
let auth = "Basic " + btoa(login + ":" + password);

let headers = new Headers();
headers.append("Content-Type", "application/json");
headers.append("Authorization", auth);

let data = JSON.stringify({
    "search": {
        "name": {
            "$regex": "cpu",
            "$options": "i"
        }
    }
});

let requestOptions = {
    method: "POST",
    headers: headers,
    body: data
};

fetch(saymonHostname + path, requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log("error", error));

const http = require("http");

let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/objects/search";
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");

let options = {
    "method": "POST",
    "hostname": saymonHostname,
    "headers": {
        "Authorization": auth,
        "Content-Type": "application/json"
    },
    "path": path
};

let req = http.request(options, function (res) {
    let chunks = [];

    res.on("data", function (chunk) {
        chunks.push(chunk);
    });

    res.on("end", function (chunk) {
        let body = Buffer.concat(chunks);
        console.log(body.toString());
    });

    res.on("error", function (error) {
        console.error(error);
    });
});

let data = JSON.stringify({
    "search": {
        "name": {
            "$regex": "cpu",
            "$options": "i"
        }
    }
});

req.write(data);
req.end();

import requests
import json

login = <...>
password = <...>
saymon_hostname = <...>
url = "https://" + saymon_hostname + "/node/api/objects/search"

body = {
    "search": {
        "name": {
            "$regex": "cpu",
            "$options": "i"
        }
    }
}

response = requests.request("POST", url, json=body, auth=(login, password))
print(response.text)

Ответ

[
    {
        "name": "CPU",
        "discovery_id": "example-CPU",
        "object_groups": [],
        "geoposition": [],
        "child_ref_ids": [],
        "child_link_ids": [],
        "child_ids": [],
        "parent_id": "5e21b85b308c3c66d64e07bc",
        "weight": 1,
        "tags": [],
        "last_state_update": 1583141090805,
        "updated": 1583916836283,
        "created": 1579268187099,
        "state_id": 7,
        "class_id": 4,
        "operations": [
            ...
        ],
        "properties": [
            {
                "name": "AgentId",
                "value": "5e21b85b308c3c66d64e07c8",
                "type_id": 8,
                "id": "5e21b85b308c3c66d64e07d5"
            },
            ...
        ],
        "manual_state": null,
        "owner_id": "5e21b752308c3c66d64e072c",
        "id": "5e21b85b308c3c66d64e07d2"
    },
    ...
]

Смотрите также

• Объект