Обзор NBI

NBI основан на Northbound Interface. Это интерфейс для систем вернхнего уровня, желающих взаимодействовать с НОКом для выполнения собственных задач.

НОК предоставляется простой HTTP REST API, используя JSON как транспортный формат. Авторизация выполняется через ключи API Keys.

API

Name	Base Path	API Access	Назначение
config	/api/nbi/config/	nbi:config	Запрос конфигурации устройства
configrevisions	/api/nbi/configrevisions/	nbi:configrevisions	Запрос списка версии конфигурации устройства
getmappings	/api/nbi/getmappings/	nbi:getmappings	Запрос привязки идентификатора устройства к внешним системам (и обратная операция)
objectmetrics	/api/nbi/objectmetrics/	nbi:objectmetrics	Запрос метрик устройства
objectstatus	/api/nbi/objectstatus/	nbi:objectstatus	Запрос доступности устройства
path	/api/nbi/path/	nbi:path	Запрос пути по топологии между двумя устройствами или интерфейсами
telemetry	/api/nbi/telemetry/	nbi:telemetry	Отправка метрик в НОК