Получить историю метрик связи

Возвращает историю метрик связи.

Запрос

HTTP Запрос

GET /node/api/links/:id/history

Права

linkPermissions

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

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

обязательный | ID связи. |

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

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

обязательный | Список запрашиваемых метрик через запятую. | | from | String

обязательный | От какой даты искать записи. | | downsample | String | Параметр даунсемплинга. Например, 1m-avg или 1h-avg означают "среднее за минуту" и "среднее за час" соответственно. | | timezone | String | Часовой пояс для времени метрики. Например, Europe/Moscow. Используйте этот параметр, если часовой пояс сервера отличается от нужного часового пояса. | | to | String | До какой даты искать записи. |

Тело запроса

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

Ответ

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

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

NOTE

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

Пример

Запрос

• Bash
• JavaScript
• NodeJS
• Python

login=<...>
password=<...>
saymon_hostname=<...>
link_id=<...>
url=https://$saymon_hostname/node/api/links/$link_id/history

curl -X GET $url -u $login:$password -G \
    --data-urlencode "metrics=packetsTransmitted,packetsReceived" \
    --data-urlencode "from=1580906276000"

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

let queryParams = "metrics=packetsTransmitted,packetsReceived" +
    "&" + "from=1580906276000";

let path = "/node/api/links/" + linkId + "/history" + "?" + 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));

const http = require("http");
const querystring = require("querystring");

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

let queryParams = querystring.stringify({
    metrics : "packetsTransmitted,packetsReceived",
    from : "1580906276000"
});

let path = "/node/api/links/" + linkId + "/history" + "?" + 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();

import requests

login = <...>
password = <...>
saymon_hostname = <...>
link_id = <...>
url = "https://" + saymon_hostname + "/node/api/links/" + \
    link_id + "/history"

params = {
    "metrics": "packetsTransmitted,packetsReceived",
    "from": "1580906276000"
}

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

Ответ

[
    {
        "metric": "packetsTransmitted",
        "tags": {
            "entity": "link5e7df795f988c426bb37215e"
        },
        "aggregateTags": [],
        "dps": [
            [
                1662121832050,
                4
            ],
            [
                1662121839385,
                4
            ]
            ...
        ]
    },
    {
        "metric": "packetsReceived",
        "tags": {
            "entity": "link5e7df795f988c426bb37215e"
        },
        "aggregateTags": [],
        "dps": [
            [
                1662121832050,
                4
            ],
            [
                1662121839385,
                4
            ]
            ...
        ]
    }
]

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

• Получить названия метрик связи