Справочный центр Wialon

get_stats

Для получения состояния ретрансляции сообщений за прошедший период используйте метод retranslator/get_stats. Период задается с помощью метода update_operating.

Конечная точка

Copied!
svc=retranslator/get_stats&params={
    "itemId": <long>
}

Параметры

Запрос должен содержать параметр itemId, указывающий ID ретранслятора.

Ответ

В случае успешного выполнения запроса возвращается ответ следующего формата:

Copied!
{
    "au": <long>,   /* Количество объектов, добавленных в ретранслятор. */
    "ru": <long>,   /* Количество объектов, сообщения которых еще предстоит ретранслировать. */
    "hf": <long>,   /* Начало периода, за который ретранслируются сообщения (Unix-время). */
    "hc": <uint>,   /* Время сообщений, которые ретранслируются в данный момент (Unix-время). */
    "ht": <long>,   /* Окончание периода, за который ретранслируются сообщения (Unix-время). */
    "hms": <uint>,  /* Количество сообщений в очереди. */
    "hp": <uint>    /* Процент выполнения ретрансляции. */
}

Если ретрансляция за прошедший период не запущена, значения времени и процент выполнения равны 0.

В противном случае возвращается код ошибки.

Коды ошибок

Код ошибки Описание
4 Не удалось разобрать входные параметры.
7 Указанный элемент не является ретранслятором или у пользователя нет права доступа на редактирование настроек ретранслятора, включая его запуск и остановку (бит ACL 0x100000, см. Токены).

Если вы заметили ошибку в тексте, пожалуйста, выделите её и нажмите Ctrl+Enter.