Demo
Demo
База знаний PMTA›Блок Global›Директива§ 3.3.1.45

volume-audit-api-key

Global

Ключ для передачи данных об объёме при лицензии по объёму
в конфигурации это строкаvolume-audit-api-keyвнутри блока Global
Обязателен ровно для одного вида лицензии

Строка задаёт ключ, которым узел подтверждает себя, отправляя вендору данные об отправленном объёме.

Нужен он ровно при одном виде лицензии — считающей объём. Ключ выдаётся вместе с ней, и руководство говорит прямо: при такой лицензии директива обязательна.

Умолчания нет. При лицензии другого вида строка не нужна и не проявляется.

Ключ лежит в конфигурации открытым текстом — как пароли подачи и ключи API. Значит и файл защищать надо соответственно.

Главная ловушка — отсутствие ключа при лицензии по объёму. Данные об объёме уходить не будут, и что произойдёт дальше — вопрос к вендору, а не к MTA: руководство говорит только «директива обязательна», не описывая, чем грозит её отсутствие.

Предполагать тут нечего: если лицензия считает объём, а подтверждать себя нечем, разбираться придётся с вендором.

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

Что делает Хаб. Не пишет: лицензии узлов Хаб не выдаёт и вида лицензии не знает — её ставит владелец узла.

Если на узле окажется лицензия по объёму, строку придётся дописать вручную: в генерируемой конфигурации места для неё нет. Это стоит помнить при подключении чужого узла.

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

Что ставить. Выбора нет — ключ выдаёт вендор:

Значение Когда
не писать лицензия не считает объём
ключ от вендора лицензия считает объём — тогда строка обязательна

Ключ хранится там же, где остальные секреты узла, и защищается правами на файл конфигурации.

Назначение, обязательность при лицензии по объёму и происхождение ключа — из руководства, § 3.3.1.45. Умолчания там не названо. Оценка про уход данных наружу наша.
Пример в конфигурации
# ключ выдаётся вместе с лицензией, считающей объём
volume-audit-api-key abcd0123skdju673jdksdkshd73j7shfk
Строка нужна только при этом виде лицензии. При обычной она не проявляется никак.
жёлтым — — имена директив, голубым — блоки. Так же они подсвечены и в тексте карточки.
▲

Типичные ошибки и проблемы

что делают не так и чем это кончается2 ошибки▶

Забывают ключ при лицензии по объёму

§ 3.3.1.45

Чем чреватоДанные об объёме уходить не будут. Чем это грозит, руководство не описывает — говорит только, что директива обязательна.
Как заметитьЛицензия считает объём, строки в конфигурации нет.
Как правильноДописать ключ, выданный вместе с лицензией.

Подключают чужой узел, не проверив вид лицензии

наш опыт

Чем чреватоГенерируемая конфигурация места для этой строки не содержит. Узел с лицензией по объёму после применения останется без ключа.
Как заметитьПосле применения конфигурации Хабом строка пропала.
Как правильноПроверять вид лицензии при подключении узла и дописывать ключ вручную, если он нужен.
Совместимость
PowerMTA 6.0
описана в руководстве этой версии · платформа: любая
С какой версии директива доступна, вендор указывает не для всех — здесь пометки нет. Имя встречается и в издании руководства 5.0.
Справочные данные
Синтаксис
volume-audit-api-key STRING
Значения
строка ключа, выдаваемая вендором
Применение
reload, перезапуск не нужен
Очередь
уже поставленное в очередь не затронет
Где писать
Global
Сколько раз
один раз в блоке
Всё здесь — из руководства, с разделом.
Наследование
Директива пишется в корне файла конфигурации и действует на весь узел: ключ один на экземпляр, как и лицензия. Наследования у него нет.
⇄

Связанные директивы

2 связи

Без чего не работает

Лицензия на парк, а не на серверКлюч нужен ровно при этом виде лицензии и выдаётся вместе с ней. § 3.3.1.45Закрыть права на файлы конфигурацииКлюч лежит в конфигурации открытым текстом; защищают его права на файл. § 1.6.3

Как проверить на узле
Строку читают вместе с видом лицензии:
grep -n 'volume-audit-api-key' /etc/pmta/config
pmta show license
Вторая команда показывает вид лицензии. Если она считает объём, а строки нет, конфигурацию надо дополнить — руководство называет её обязательной.
◇

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

3 статьи

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

В Хабе
Цена ошибки
безопасно: неверное значение ничего не ломает
Сценарии
Подготовить узел к отправке
Соседние настройки блока Global:postmasterincludedomain-macrothread-reusethread-min-priorityВсе 108 директив блока →