Запустить групповую операцию для объектов

Запускает групповую операцию для всех объектов, которые подходят под заданный критерий поиска.

Запрос

HTTP Запрос

POST /node/api/bulk/objects

Права

run-bulks & manage-objects

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

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

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

Тело запроса состоит из двух частей – search и bulk. search описывает критерии поиска. bulk описывает операцию, которая будет выполнена с объектами, которые подошли под заданные критерии поиска.

{
    "search": {
        ...
    },
    "bulk": [
        {
            ...
        },
        {
            ...
        }
            ...
    ]
}

Поиск

Этот запрос использует такие же критерии поиска, как и запрос Поиск объектов.

Все параметры поиска опциональны. Если вы не укажете параметры поиска, операция будет произведена над всеми параметрами в системе.

Операция

В переменной bulk описывается групповая операция, которая будет произведена над объектами, которые подошли под критерии поиска.

Параметр Тип Описание

modify

Object

Изменяемые параметры объекта. Список всех возможных параметров объекта доступен в статье Объект.

properties.createOrModify

Object

Изменяемые свойства объекта. Включают в себя пользовательские свойства, AgentId, TaskPeriodValue и TaskPeriodUnit.

stateConditions

Object

Изменяемые Условия перехода состояний.

stateTriggers

Object

Изменяемые Триггеры состояний.

incidentConditions

Object

Изменяемые Условия генерации аварии.

Тело запроса

{
    "search": {
        // Параметры поиска
    },
    "bulk": [
        {
            // Операция
        },
        {
            // Операция
        }
        ...
    ]
}

Ответ

Ответ содержит ID групповой операции и её состояние:

"JSON"

{
    "bulkId": "079b3102-c326-4dd7-bf48-a945232b32d6",
    "finished": false
}

Пример

Этот пример добавляет новое свойство всем объектам с именем "CPU", дочерним к определёному объекту.

Запрос

  • Bash

  • JavaScript

  • NodeJS

  • Python

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

curl -X POST $url -u $login:$password \
    -H "Content-Type: application/json" \
    --d @- <<EOF {
    "search": {
        "name": {
            "$regex": "^CPU$",
            "$options": "i"
        },
        "parent_id": "62d7e58056d203149a08001b"
    },
    "bulk": [
        {
            "properties.createOrModify": {
                "name": "New Property",
                "value": "value",
                "type_id": 1
            }
        }
    ]
}
EOF
let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/bulk/objects";
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"
        },
        "parent_id": "62d7e58056d203149a08001b"
    },
    "bulk": [
        {
            "properties.createOrModify": {
                "name": "New Property",
                "value": "value",
                "type_id": 1
            }
        }
    ]
});

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/bulk/objects";
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"
        },
        "parent_id": "62d7e58056d203149a08001b"
    },
    "bulk": [
        {
            "properties.createOrModify": {
                "name": "New Property",
                "value": "value",
                "type_id": 1
            }
        }
    ]
});

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

login = <...>
password =  <...>
saymon_hostname = <...>

url = "http://" + saymon_hostname + "/node/api/bulk/objects"

body = {
    "search": {
        "name": {
            "$regex": "^CPU$",
            "$options": "i"
        },
        "parent_id": "62d7e58056d203149a08001b"
    },
    "bulk": [
        {
            "properties.createOrModify": {
                "name": "New Property",
                "value": "value",
                "type_id": 1
            }
        }
    ]
}

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

Ответ

{
    "bulkId": "079b3102-c326-4dd7-bf48-a945232b32d6",
    "finished": false
}