Получить N последних метрик объекта

Получить N последних метрик объекта

Получить N последних метрик объекта ​

Возвращает определённое количество недавних метрик объекта.

Запрос ​

HTTP Запрос ​

text
GET /node/api/objects/:id/last

Права ​

text
objectPermissions

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

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

обязательный | ID или discovery ID объекта. |

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

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

обязательный | Список метрик, перечисленных через запятую.. | | length | Integer | Количество метрик. Если не указано, то запрос вернёт самую недавнюю метрику. |

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

Тело запроса пустое.

Ответ ​

Возвращает массив запрошенных метрик. Каждая метрика содержит следующие поля:

ПолеТипОписание
metricStringИмя метрики.
tags.entityStringID сущность с префиксом типа сущности. Формат поля objectxxx для объектов и linkxxx для связей.
dpsArray<DataPoint>Массив точек данных. Каждая точка состоит из массива из двух значений. Первое значение это время получение метрики, второе – значение метрики в этот момент времени.

Если указать несуществующую метрику в параметре metrics или указать временной промежуток за пределами допустимых границ (от 1 часа до 1 года), то этот запрос вернёт пустую историю для этой метрики:

json
 {
     "metric": "ICMP",
     "tags": {
         "entity": ""
     },
     "aggregateTags": [],
     "dps": []
 }

NOTE

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

Пример ​

Запрос ​

  • Bash
  • JavaScript
  • NodeJS
  • Python
bash
login=<...>
password=<...>
saymon_hostname=<...>
object_id=<...>
url=https://$saymon_hostname/node/api/objects/$object_id/last

curl -X GET $url -u $login:$password -G \
    --data-urlencode "metrics=percentageUsage.combined" \
    --data-urlencode "length=5"
javascript
let login = <...>
let password = <...>
let saymonHostname = <...>
let objectId = <...>

let queryParams =
    "metrics=percentageUsage.combined" + "&" +
    "length=5"

let path = "/node/api/objects/" + objectId + "/last" + "?" + queryParams;

let auth = "Basic " + btoa(login + ":" + password);

let headers = new Headers();
headers.append("Authorization", auth);

let requestOptions = {
    method: "GET",
    headers: headers
};

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

let login = <...>
let password = <...>
let saymonHostname = <...>
let objectId = <...>

let queryParams = querystring.stringify({
    metrics : "percentageUsage.combined",
    length : "5"
});

let path = "/node/api/objects/" + objectId + "/last" + "?" + queryParams;
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");

let options = {
    "method": "GET",
    "hostname": saymonHostname,
    "headers": {
        "Authorization": auth
    },
    "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);
    });
});

req.end();
python
import requests

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

params = {
"metrics": "percentageUsage.combined",
    "length": "5"
}

response = requests.request("GET", url, auth=(login, password), params=params)
print(response.text)

Ответ ​

json
[
    {
        "metric": "percentageUsage.combined",
        "tags": {
            "entity": "obj5e7dc67bc50bdc08abbf16ac"
        },
        "aggregateTags": [],
        "dps": [
                [
                    1680787492525,
                    4
                ],
                [
                    1680787512535,
                    4
                ],
                [
                    1680787522525,
                    4
                ],
                [
                    1680787542533,
                    4
                ],
                [
                    1680787552553,
                    4
                ]
            ]
    }
]

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