База знаний PMTA›Точка API§ 5.2

Корень веб-монитора

monitor base URL

Точка входа

Отдаёт начальную страницу монитора структурой: сведения об установке и таблицу доменов с наибольшей очередью.

Вызов — GET /?format=json (или xml). Без параметра корень перенаправляет на страницу для человека /ui, а структуру отдаёт только адрес без этого суффикса.

Таблица доменов здесь — верхушка, а не список: длину задаёт http-default-max-items, по умолчанию десять строк.

Порт и схема. Монитор слушает http-mgmt-port, по умолчанию 8080. При умолчании http-redirect-to-https запрос по http перенаправляется на https, так что скрипту проще сразу идти по https — с самоподписанным сертификатом, если своего не ставили.

Доступ решает http-access по адресу, откуда пришёл запрос, — для чтения хватает уровня monitor. Ключ из http-api-key в заголовке X-API-Key даёт полный доступ с любого адреса.

Главная ловушка — адрес с /ui. Ссылку на монитор обычно копируют из браузера, а там уже /ui: такой запрос вернёт страницу для человека, и разбор ответа сломается на первом символе. Структура приходит только с корня и параметром format.

Что делает Хаб. Не спрашивает: опрос узла раз в минуту берёт /status и /queues, экран «Мониторинг PMTA» — ещё /domains, /vmtas и /jobs. Корень остаётся ручным инструментом.

Рекомендуемые значения

О чём спрашивать эту точку:

Вопрос	Она ли
что за установка и какие домены в очереди первыми	да
полное состояние узла	нет — это /status
все домены в очереди	нет — и /domains отдаёт верхушку той же длины
что было вчера	нет — это учёт

Адрес без /ui, параметр формата, длина таблицы доменов, порт и перенаправление на https — из руководства (§ 5.1, § 5.2, § 3.3.1.58.1–2, § 3.3.1.58.23). Разграничение вопросов наше.

Пример в конфигурации

# корень монитора структурой: без суффикса /ui
curl -s 'http://127.0.0.1:8080/?format=json'

Порт 8080 — умолчание http-mgmt-port. С суффиксом /ui тот же адрес отдал бы страницу для человека.

жёлтым — — имена директив, голубым — блоки. Так же они подсвечены и в тексте карточки.

Совместимость

PowerMTA 6.0

описана в руководстве этой версии · платформа: любая

С какой версии директива доступна, вендор указывает не для всех — здесь пометки нет. Имя встречается и в издании руководства 5.0.

⇄

Связанные записи

1 связь

Чем можно заменить

Состояние узла целиком одним документомСмежная запись каталога. § 5.3

Как проверить на узле

Проверить, что корень отвечает структурой, а не страницей:

curl -s -o /dev/null -w "%{http_code} %{content_type}\n" 'http://127.0.0.1:8080/?format=json'

Тип с json — структура пришла. Код 403 — адрес запроса не разрешён в http-access; перенаправление на https — действует умолчание http-redirect-to-https, повторить по https с ключом -k; тип text/html — запрос ушёл на страницу для человека.

◇

Что ещё почитать

3 статьи

◇Ключ активации — условие установки, а не шаг после неёБез ключа активации от поддержки SparkPost MTA не ставится и не работает, а уровень лицензии задаёт потолок исходящих соединений: на стандартной всё сверх 200 игнорируется.◇Ограничения облакаОблака ограничивают исходящую почту через порт 25, пока не попросишь снять лимит, а их диапазоны адресов почтовики встречают с подозрением.◇Как перевести план отправки в железоДве постоянные, по которым считается любой узел: около 2 КБ памяти на каждого получателя в очереди и место под спул, пропорциональное суммарному размеру писем.

В Хабе

Цена ошибки: безопасно: неверное значение ничего не ломает
Сценарии: Подготовить узел к отправке