Группы камер
Группа камер - это набор камер, установленных в одном и том же месте или используемых для схожих целей.
Вывести список групп камер
Для того чтобы отобразить список групп камер, используйте следующий метод:
GET /camera-groups/
Запрос содержит следующие QUERY-STRING PARAMETERS:
Название |
Схема JSON |
Описание |
---|---|---|
|
integer |
Количество выводимых результатов. |
|
string |
Допустимые значения: |
Чтобы узнать id
группы камеры, укажите значения для полей limit
и ordering
.
CURL пример
curl -X GET "http://<findface-ip:port>/camera-groups/?limit=3&ordering=id" \
-H "Accept: application/json" \
-H "Content-Language: ru" \
-H "Accept-Language: ru" \
-H "Authorization: Token <token>" \
В случае успешного ответа (OK: 200) возвращается объект, содержащий массив результатов со следующими параметрами. Пример.
Совет
* – означает, что параметр является обязательным. 🆁 – только для чтения.
Название |
Схема JSON |
Описание |
---|---|---|
|
integer 🆁 |
ID группы камер. |
|
date-time 🆁 |
Дата создания объекта. |
|
date-time 🆁 |
Дата изменения объекта. |
|
boolean |
Обрабатывать события из этой группы камер. |
|
string |
Название группы камер, до 256 знаков. |
|
string |
Комментарий, до 2048 символов. |
|
boolean |
|
|
integer |
Тайм-аут дедупликации событий (от 1 до 10000). Значение по умолчанию: 15. |
|
любое значение string |
Метки, используемые для выделения определенного экземпляра findface-video-worker для обработки видеопотоков из этой группы камер. |
|
любое значение string |
Разрешения в данной группе камер. |
|
number┃null |
Порог схожести для лица (от 0 до 1). |
|
number┃null |
Порог схожести для силуэта (от 0 до 1). |
|
number┃null |
Порог схожести для автомобиля (от 0 до 1). |
Пример ответа
{
"results": [
{
"id": -1,
"created_date": "2023-01-16T13:44:36.531501Z",
"modified_date": "2023-01-16T13:44:36.531519Z",
"active": true,
"name": "Video archive default Camera Group",
"comment": "",
"deduplicate": false,
"deduplicateDelay": 15,
"labels": {},
"permissions": {
"1": "edit",
"2": "view",
"3": "view"
},
"face_threshold": null,
"body_threshold": null,
"car_threshold": null
}
]
}
Создать группу камер
Чтобы добавить новую группу камер, используйте следующий метод:
POST /camera-groups/
Тело запроса обязательно и содержит application/json объект со следующими параметрами. Пример.
Название |
Схема JSON |
Описание |
---|---|---|
|
boolean |
Обрабатывать события из этой группы камер. |
|
string |
Название группы камер, до 256 знаков. |
|
string |
Комментарий, до 2048 символов. |
|
boolean |
|
|
integer |
Тайм-аут дедупликации события (от 0 до 10000). Значение по умолчанию: 15. |
|
любое значение string |
Метки, используемые для выделения определенного экземпляра findface-video-worker для обработки видеопотоков из этой группы камер. |
|
любое значение string |
Разрешения в данной группе камер. |
|
number┃null |
Порог схожести для лица (от 0 до 1). |
|
number┃null |
Порог схожести для силуэта (от 0 до 1). |
|
number┃null |
Порог схожести для автомобиля (от 0 до 1). |
CURL пример
curl -X POST "http://<findface-ip:port>/camera-groups/" \
-H "Accept: application/json" \
-H "Content-Language: ru" \
-H "Accept-Language: ru" \
-H "Authorization: Token <token>" \
-H "Content-Type: application/json" \
-d '{"active":false,"name":"Test_camera_group","comment":"AAAAAA","deduplicate":false,"deduplicateDelay":0,"labels":{},"permissions":{},"face_threshold":0,"body_threshold":0,"car_threshold":0}' \
Пример запроса
Совет
Этот пример приведен только для ознакомления, подставьте свои значения в соответствующие поля. Вы можете заполнить только обязательные поля, а остальные будут по умолчанию.
Вы можете отправить в запросе следующие параметры:
{
"active": false,
"name": "Test_camera_group",
"comment": "AAAAAA",
"deduplicate": false,
"deduplicateDelay": 0,
"labels": {},
"permissions": {},
"face_threshold": 0,
"body_threshold": 0,
"car_threshold": 0
}
В случае успешного ответа (Created: 201) возвращается объект со следующими параметрами. Пример.
Пример ответа
{
"id": 2,
"created_date": "2023-01-23T12:14:09.885006Z",
"modified_date": "2023-01-23T12:14:09.885030Z",
"active": false,
"name": "Test_camera_group",
"comment": "AAAAAA",
"deduplicate": false,
"deduplicateDelay": 0,
"labels": {},
"permissions": {
"1": "edit"
},
"face_threshold": 0,
"body_threshold": 0,
"car_threshold": 0
}
Используйте id
группы камер для того, чтобы отправить POST
запрос для создания новой камеры.
Полезные API запросы
GET /camera-groups/
POST /camera-groups/
GET /camera-groups/{id}/
DELETE /camera-groups/{id}/
PATCH /camera-groups/{id}/
GET /camera-groups/count/