更新时间:2024-05-22 GMT+08:00
分享

API概览

认证管理

接口

说明

POST /v1/{user_id}/enterprises/access-token

获取用户北向接口认证AccessToken

设备组管理

接口

说明

GET /v1/{user_id}/device-orgs/{device_org_id}/sub-orgs

查询子级设备组织

GET /v1/{user_id}/device-orgs/{device_org_id}/devices

查询企业下的组织的设备列表

PUT /v1/{user_id}/device-orgs/{device_org_id}

修改设备分组名称

POST /v1/{user_id}/device-orgs

添加设备分组

DELETE /v1/{user_id}/device-orgs/{device_org_id}

删除单个设备组

POST /v1/{user_id}/device-orgs/{device_org_id}/move-devices

移动多个设备到新的设备组

GET /v1/{user_id}/device-orgs/tree

根据设备组名称查询设备组织树(支持设备组名称模糊查询)

设备管理

接口

说明

GET /v1/{user_id}/devices/{device_id}

用户根据设备ID查询设备信息详情

GET /v1/{user_id}/devices

用户查询设备列表

GET /v1/{user_id}/devices/{device_id}/gateway

查询设备网关(仅支持国标)

PUT /v1/{user_id}/devices/{device_id}

修改设备信息

PUT /v1/{user_id}/devices/{device_id}/gb-account

修改国标设备账号

POST /v1/{user_id}/devices/holosens

添加好望设备

POST /v1/{user_id}/devices/gb/batch-add

批量添加国标设备

POST /v1/{user_id}/devices/batch-delete

批量删除设备

通道管理

接口

说明

PUT /v1/{user_id}/devices/{device_id}/channels/{channel_id}

修改通道信息

GET /v1/{user_id}/channels

查询通道列表

GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}

查询通道详情

云台控制

接口

说明

GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/control-lock

获取云台控制权

POST /v1/{user_id}/devices/{device_id}/channels/{channel_id}/control-lock

释放云台控制权

POST /v1/{user_id}/devices/{device_id}/channels/{channel_id}/ptz/angle-spin

云台点动转动

媒体播放管理

接口

说明

POST /v2/{user_id}/devices/channels/media/live-connections

获取实况地址统一接口

GET /v2/{user_id}/devices/{device_id}/channels/{channel_id}/media/records

查询回放列表统一接口

GET /v2/{user_id}/devices/{device_id}/channels/{channel_id}/media/playback-connections

获取回放地址统一接口

POST /v1/{user_id}/media/urls/batch-delete

批量删除播放地址

GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/cloud-records

【旧】查询通道的云端录像列表

GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/cloud-records/playback-url

【旧】查询通道的云端录像回放地址

GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/device-records

【旧】查询通道的前端录像列表

GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/device-records/playback-url

【旧】查询通道的前端录像回放地址(仅支持国标协议)

GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/device-records/web-playback-url

【旧】查询通道的前端录像回放地址

POST /v1/{user_id}/devices/channels/cloud-live/url

【旧】批量获取设备实况播放地址

POST /v1/{user_id}/devices/channels/p2p-connect/live

【旧】批量获取通道实况P2P地址(仅支持好望协议)

POST /v1/{user_id}/devices/channels/p2p-connect/playback

【旧】批量获取通道录像回放P2P地址(仅支持好望协议)

行业数据流管理-消息管理

接口

说明

POST /v1/{user_id}/messages/callback

配置用户消息通知URL

DELETE /v1/{user_id}/messages/callback

删除用户消息通知URL

GET /v1/{user_id}/messages/callback

查询用户消息通知URL

行业数据流管理-图片下载

接口

说明

POST /v1/{user_id}/intelligence-data/pictures

批量获取智能图片下载路径

POST /v1/{user_id}/alarms/pictures

批量获取智能告警图片下载路径

行业数据流管理-云端抓拍

接口

说明

GET /v1/{user_id}/devices/snap

云端抓拍设备图片

行业数据流管理-智能统计

接口

说明

GET /v1/{user_id}/statistics/people

查询客流统计信息

GET /v1/{user_id}/time-heatmap

获取时间热度图统计

GET /v1/{user_id}/space-heatmap

获取空间热度图统计

录像配置管理

接口

说明

PUT /v1/{user_id}/devices/channels/record-plan

批量为通道设置录像计划

POST /v1/{user_id}/devices/channels/record-plan

批量删除通道录像计划

GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/record-plan

查询通道的录像计划

GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/time-policy

查询通道存储时间策略

PUT /v1/{user_id}/devices/channels/record-config

批量设置通道录像参数

GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/record-config

查询通道录像参数

PUT /v1/{user_id}/devices/channels/time-policy

批量设置通道存储时间策略

PUT /v1/{user_id}/devices/channels/record-alarm-plan

批量设置通道动检录像计划

GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/record-alarm-plan

查询通道的动检录像计划

智能图片下载

接口

说明

POST /v1/{user_id}/intelligence-data/pictures

批量获取智能图片下载路径

服务开通关闭管理

接口

说明

POST /v1/{user_id}/devices/channels/resources

批量开通设备通道服务

DELETE /v1/{user_id}/devices/channels/resources

批量关闭设备通道服务

资源管理

接口

说明

GET /v1/{user_id}/resources

查询包周期和按需资源列表

GET /v1/{user_id}/resources/{resource_id}/channels

查询包周期或按需资源下的通道列表

GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/resources

查询通道下的资源列表

告警图片下载

接口

说明

POST /v1/{user_id}/alarms/pictures

传入告警分类及告警ID数据生成图片下载路径列表

目标库

接口

说明

POST /v1/{user_id}/target/batch-delete

删除目标信息

PUT /v1/{user_id}/targets

批量修改目标信息

POST /v1/{user_id}/targets/batch-add

目标批量添加

GET /v1/{user_id}/targets/ids

按索引范围获取目标ID列表

GET /v1/{user_id}/target-groups

获取目标库分组

POST /v1/{user_id}/target-groups

新增目标库分组

PUT /v1/{user_id}/target-groups

修改目标库分组

DELETE /v1/{user_id}/target-groups

删除目标库分组

POST /v2/{user_id}/target-groups

新增目标库分组v2

PUT /v2/{user_id}/target-groups

修改目标库分组v2

DELETE /v2/{user_id}/target-groups

删除目标库分组v2

GET /v1/{user_id}/targets

按索引范围获取目标信息列表

POST /v1/{user_id}/targets

获取目标信息(IVS1800不支持)

GET /v1/{user_id}/targets/count

获取目标库分组中的目标数量

巡航轨迹和预置位

接口

说明

GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/cruise-track/list

获取巡航轨迹列表

DELETE /v1/{user_id}/devices/{device_id}/channels/{channel_id}/preset-position

删除摄像机预置位

PUT /v1/{user_id}/devices/{device_id}/channels/{channel_id}/cruise-track

修改摄像机巡航轨迹

POST /v1/{user_id}/devices/{device_id}/channels/{channel_id}/cruise-track

添加摄像机巡航轨迹

POST /v1/{user_id}/devices/{device_id}/channels/{channel_id}/preset-position

添加摄像机预置位

GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/cruise-track

查询指定巡航轨迹详情

PUT /v1/{user_id}/devices/{device_id}/channels/{channel_id}/cruise-track/enable

启停摄像机巡航轨迹

DELETE /v1/{user_id}/devices/{device_id}/channels/{channel_id}/cruise-track

删除摄像机巡航轨迹

PUT /v1/{user_id}/devices/{device_id}/channels/{channel_id}/preset-position

修改摄像机预置位

POST /v1/{user_id}/devices/{device_id}/channels/{channel_id}/preset-position/move

移动摄像机转到预置位

GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/preset-position

查询摄像机预置位列表

查询设备码流能力和码流列表

接口

说明

GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/stream-ability

查询设备码流能力和码流列表

GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/stream-detail

查询设备码流详情,目前仅支持好望设备

POST /v1/{user_id}/devices/{device_id}/channels/{channel_id}/stream-detail

设备码流配置

设备密码修改

接口

说明

GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/security-key

查询设备密码状态,仅支持好望SDC直连设备

PUT /v1/{user_id}/devices/{device_id}/channels/{channel_id}/security-key

设置或修改设备密码,仅支持好望SDC直连设备

设备目标授权配置

接口

说明

PUT /v1/{user_id}/devices/{device_id}/channels/targets/authorization

批量设置通道目标授权状态,只支持好望设备

GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/targets/authorization

查询设备目标授权状态,仅支持好望设备

云上能力集管理

接口

说明

POST /v1/{user_id}/devices/ability

批量查询版本能力集

相关文档