Как пользоваться HTTP API для управления видеодетекцией лиц

В этом разделе:

Точка доступа

Все запросы HTTP API для управления видеодетекцией лиц нужно отправлять на адрес http://<findface-video-manager IP address>:18810/. Запросы обрабатываются компонентом findface-video-manager.

Объект типа job (задание)

Объект job представляет собой задание на обработку видеопотока, выдаваемое компонентом findface-video-manager компоненту findface-video-worker.

Объект job имеет следующие атрибуты:

• id: id job-задания, установленный пользователем.
• stream_url: URL/адрес видеопотока или файла для обработки.
• labels: метки, по которым будет осуществляться обработка обнаруженных лиц в компоненте findface-facerouter.
• single_pass: если true (по умолчанию false), то не перезапускать обработку потока в случае ошибки.
• router_url: IP-адрес и порт компонента findface-facerouter, на который компонент findface-video_worker будет отправлять обнаруженные лица для обработки.
• status: статус job-задания.
• status_msg: дополнительная информация о статусе job-задания.
• statistic: статистика выполнения задания (продолжительность использования задания, количество отправленных лиц).
• worker_id: id экземпляра findface-video-worker, выполняющего job-задание.

Сообщения об ошибках

Если метод выполнить не удается, Сервер возвращает ответ с кодом HTTP, отличном от 200, а также тело ответа в формате JSON, содержащее описание ошибки. Тело ответа всегда содержит хотя бы 2 поля — code и desc.

• code — это код ошибки в виде CAPS_AND_UNDERSCORES, который может быть использован для автоматического преобразования.
• desc — это описание ошибки, предназначенное для прочтения человеком.

Полный список ошибок

Код ошибки	Описание	Код HTTP
UNKNOWN_ERROR	Ошибка неизвестного происхождения.	500
BAD_REQUEST	Запрос не может быть прочитан, или некоторые параметры метода неверно заданы.	400
CONFLICT	Конфликт.	409
NOT_FOUND	Job-задание не найдено.	404
DELETING	Выполняется запрошенное ранее удаление задания.	423