---
title: 'Диагностика API'
description: Служебная проверка обмена данными между AI Analytics и платформой приборов учёта, прозванивающая все запросы, на которые опираются остальные отчёты.
section: AI Analytics
weight: 9
---

import Alert from '@/components/docs/Alert.astro';

Служебная проверка обмена данными между AI Analytics и платформой приборов учёта. Отчёт по очереди обращается ко всем запросам платформы, которыми пользуются остальные отчёты, и показывает, какие из них отвечают нормально, а какие возвращают ошибку. Адресат — администратор и техническая поддержка: запустите его при подозрении на сбой интеграции и сразу увидите, где разорвана связь с прибором или сервером.

<Alert type="info">
  Это служебный инструмент для администратора. Он доступен по прямой ссылке, а не из общего списка
  отчётов, который видят операторы.
</Alert>

## Что показывает

По каждому виду запроса платформы — строка с результатом: какой адрес вызывали, успешно ли ответил сервер, сколько строк данных вернул и какие поля были в первой строке (чтобы убедиться, что формат данных не изменился).

| Элемент строки | Что означает                                                                                                                   |
| -------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Адрес запроса  | какой именно вид данных проверяли (вход в систему, список парка, справочники, сеансы связи, архивы показаний, паспорт прибора) |
| Состояние      | ответил ли сервер успешно или вернул ошибку                                                                                    |
| Число строк    | сколько записей пришло в ответе                                                                                                |
| Примеры полей  | имена полей из первой записи — признак, что формат не изменился                                                                |

Цвет строки задаёт код ответа сервера:

| Цвет                                                     | Что означает                               |
| -------------------------------------------------------- | ------------------------------------------ |
| Зелёный («200»)                                          | запрос работает нормально                  |
| Жёлтый (ошибка прав, кроме «не найдено»)                 | нужно проверить права доступа              |
| Красный (серверная ошибка или нет своевременного ответа) | проблема на стороне сервера                |
| Серый («404» — не найдено)                               | такого запроса нет в этой версии платформы |

<Alert type="note">
  Адреса вроде `/api/v1/stations` и имена полей вроде `archive_type` — это технические
  идентификаторы запросов и полей платформы, а не настройки для оператора.
</Alert>

## Как считается

Отчёт по очереди обращается ко всем запросам платформы, которыми пользуются другие отчёты: вход в систему, список парка, справочники (типы приборов, ресурсоснабжающие организации, клиенты), сеансы связи (в четырёх вариантах параметров), архивы показаний (часовой, суточный, месячный, настройки), архивы нештатных ситуаций и журналы событий, а также паспорт прибора. Для каждого вызова фиксируется адрес, ответ сервера, число строк и пример полей. Если указан конкретный узел, дополнительно проверяются архивы нештатных ситуаций именно по нему.

## Параметры запуска

| Параметр                                               | По умолчанию         | Что означает                                                                               |
| ------------------------------------------------------ | -------------------- | ------------------------------------------------------------------------------------------ |
| ID узла для проверки архивов нештатных (необязательно) | берётся из контекста | если задан — проверка идёт по этому узлу; если пусто — берётся первый узел из списка парка |

## Как читать результат

Смотрите на цвет строк. Сплошь зелёные — обмен данными исправен. Жёлтые строки означают, что сервер на месте, но не отдаёт данные без нужных прав, — это повод проверить доступ. Красные строки — сбой на стороне сервера, их разбирают в первую очередь. Серые строки («не найдено») часто нормальны: не все приборы поддерживают все виды архивов, поэтому отсутствие архивов нештатных ситуаций у конкретного прибора не является ошибкой.

Учтите особенность входа в систему: платформа около двух недель переиспользует ранее полученный пропуск, поэтому проверка входа обычно успешна и без реального повторного входа на сервер.

## Связанные отчёты

Этот отчёт самостоятелен и ни от чего не зависит. Все остальные отчёты парка пользуются теми же запросами платформы, что он проверяет, — поэтому при их сбое диагностику стоит начинать отсюда.