设备
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
AddFaceDeviceGroup | 调用该接口创建人脸底库设备组 | 查看文档去调试 |
AddFaceDeviceToDeviceGroup | 将设备加入设备分组 | 查看文档去调试 |
QueryDeviceEvent![]() | 调用该接口查询IPC设备的智能告警事件列表 | 查看文档去调试 |
QueryDevicePictureFile![]() | 调用该接口查询IPC设备获取的图片信息 | 查看文档去调试 |
QueryDevicePictureLifeCycle | 调用该接口查询IPC设备的云存储图片生命周期 | 查看文档去调试 |
QueryDeviceVodUrlByTime![]() | 调用该接口,获取本地NVR设备或IPC设备存储卡中,指定录像时间范围的录像文件播放地址 | 查看文档去调试 |
QueryFaceAllDeviceGroup | 查询所有设备分组 | 查看文档去调试 |
QueryFaceDeviceGroupsByDevice | 查询设备所在的设备分组 | 查看文档去调试 |
QueryLiveStreaming![]() | 调用该接口获取IPC设备的直播开播地址 | 查看文档去调试 |
QueryVoiceIntercom![]() | 调用该接口获取IPC设备的语音对讲地址 | 查看文档去调试 |
SetDevicePictureLifeCycle | 调用该接口设置IPC设备的云存储图片生命周期 | 查看文档去调试 |
StopLiveStreaming | 调用该接口停止IPC设备推流 | 查看文档去调试 |
DeleteFaceDeviceGroup | 删除设备分组 | 查看文档去调试 |
RemoveFaceDeviceFromDeviceGroup | 将设备移出设备分组 | 查看文档去调试 |
用户
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
AddFaceUserGroup | 调用该接口创建用户组 | 查看文档去调试 |
AddFaceUserToUserGroup | 调用该接口将用户添加到用户组 | 查看文档去调试 |
QueryFaceAllUserGroupAndDeviceGroupRelation | 查询已添加人脸同步关系的用户组和设备组 | 查看文档去调试 |
QueryFaceUserGroupAndDeviceGroupRelation | 查询用户组、设备组人脸同步关系 | 查看文档去调试 |
QueryFaceUserIdByCustomUserId | 根据调用者系统中的用户Id查询人脸底库同步服务中的用户Id | 查看文档去调试 |
QueryFaceAllUserGroup | 查询所有用户分组 | 查看文档去调试 |
QueryFaceAllUserIdsByGroupId | 查询用户组下的所有用户 | 查看文档去调试 |
QueryFaceCustomUserIdByUserId | 根据人脸底库同步服务用户 ID 查询调用者服务中的用户 ID | 查看文档去调试 |
QueryFaceUser | 查询用户详细信息 | 查看文档去调试 |
QueryFaceUserGroup | 查询用户所在的用户组 | 查看文档去调试 |
UpdateFaceUserGroupAndDeviceGroupRelation | 调用该接口,更新用户组与设备组之间的人脸同步关系 | 查看文档去调试 |
UpdateFaceUser | 更新用户信息 | 查看文档去调试 |
DeleteFaceUserGroup | 调用该接口删除指定的用户组 | 查看文档去调试 |
RemoveFaceUserFromUserGroup | 将用户从用户分组中移除 | 查看文档去调试 |
人脸
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
AddFaceUser | 调用该接口向人脸底库添加一个用户 | 查看文档去调试 |
AddFaceUserGroupAndDeviceGroupRelation | 用户组、设备组添加人脸同步关系 | 查看文档去调试 |
AddFaceUserPicture | 调用该接口,为人脸底库中的用户增加一张人脸图片 | 查看文档去调试 |
DeleteFaceUser | 向人脸管理服务删除一个用户 | 查看文档去调试 |
DeleteFaceUserGroupAndDeviceGroupRelation | 调用该接口,删除用户组与设备组之间的人脸同步关系 | 查看文档去调试 |
DeleteFaceUserPicture | 调用该接口,从人脸底库的用户中删除指定的人脸图片 | 查看文档去调试 |
CheckFaceUserDoExistOnDevice | 检查指定用户是否在设备上同步人脸成功 | 查看文档去调试 |
ClearFaceDeviceDB | 调用该接口,清空V系列边缘一体机的指定业务隔离ID下所有人脸底库 | 查看文档去调试 |
图片搜索
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
CreatePictureSearchApp | 调用该接口创建以图搜图应用实例 | 查看文档去调试 |
CreatePictureSearchJob | 调用该接口创建一体化以图搜图任务 | 查看文档去调试 |
QueryPictureSearchAiboxes | 调用该接口,查询以图搜图应用实例绑定的V系列边缘一体机列表 | 查看文档去调试 |
QueryPictureSearchApps | 调用该接口,查询已创建的以图搜图应用实例列表 | 查看文档去调试 |
QueryPictureSearchDevices | 调用该接口,查询以图搜图应用实例绑定的设备列表 | 查看文档去调试 |
QueryPictureSearchJob | 调用该接口,查询一体化以图搜图任务列表 | 查看文档去调试 |
QueryPictureSearchJobResult | 调用该接口,查询一体化以图搜图任务的图片检索结果 | 查看文档去调试 |
GetPictureSearchJobStatus | 调用该接口获取一体化以图搜图任务的状态 | 查看文档去调试 |
QueryPictureFiles | 调用该接口获取图片列表 | 查看文档去调试 |
UpdatePictureSearchApp | 调用该接口修改以图搜图应用实例的信息 | 查看文档去调试 |
BindPictureSearchAppWithDevices | 调用该接口可用以图搜图实例批量绑定设备 | 查看文档去调试 |
UnbindPictureSearchAppWithDevices | 调用该接口,批量解绑以图搜图应用实例关联的设备 | 查看文档去调试 |
PictureSearchPicture | 调用该接口启动以图搜图应用实例,进行图片检索 | 查看文档去调试 |
TriggerCapturePicture | 调用该接口主动触发IPC设备拍摄图片并上传至云端 | 查看文档去调试 |
录像
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
CreateRecordPlan![]() | 调用该接口,根据时间模板创建录像计划 | 查看文档去调试 |
AddRecordPlanDevice | 调用该接口为IPC设备添加连续录像计划 | 查看文档去调试 |
QueryRecord![]() | 调用该接口查询云端录像列表 | 查看文档去调试 |
QueryRecordByRecordId | 调用该接口通过录像文件ID查询录像文件URL | 查看文档去调试 |
QueryRecordPlanDetail | 调用该接口查询录像计划详情 | 查看文档去调试 |
QueryRecordPlanDeviceByDevice | 调用该接口根据IPC的设备ID,查询该视频设备的录像计划 | 查看文档去调试 |
QueryRecordPlanDeviceByPlan | 调用该接口查询录像计划关联的设备 | 查看文档去调试 |
QueryRecordPlans | 调用该接口查询录像计划列表 | 查看文档去调试 |
QueryRecordUrl![]() | 调用该接口查询云端录像文件的播放地址 | 查看文档去调试 |
QueryTimeTemplate | 调用该接口查询设备的时间模板信息 | 查看文档去调试 |
QueryDeviceEventRecord | 调用该接口获取IPC设备的指定智能告警事件,对应的录像文件URL | 查看文档去调试 |
QueryDeviceVodUrl | 调用该接口,获取本地NVR设备或IPC设备的存储卡中,指定录像文件名的录像文件URL | 查看文档去调试 |
QueryMonthRecord | 调用该接口,查询IPC设备某月份的每一天是否有录像 | 查看文档去调试 |
QueryDeviceRecordLifeCycle | 调用该接口,获取IPC设备在云端保存录像文件的时间,即录像生命周期 | 查看文档去调试 |
QueryEventRecordPlanDetail | 调用该接口查询智能告警事件录像计划详情 | 查看文档去调试 |
QueryEventRecordPlanDeviceByDevice | 调用该接口,根据IPC的设备ID查询智能告警事件录像计划 | 查看文档去调试 |
QueryEventRecordPlanDeviceByPlan | 调用该接口,查询智能告警事件录像计划,关联的摄像头列表 | 查看文档去调试 |
QueryEventRecordPlans | 调用该接口查询智能告警事件录像计划列表 | 查看文档去调试 |
SetDeviceRecordLifeCycle | 调用该接口,设置IPC设备的录像生命周期,即录像文件在云端存储的天数 | 查看文档去调试 |
StopTriggeredRecord | 调用该接口使IPC设备停止主动触发录像 | 查看文档去调试 |
UpdateEventRecordPlan | 调用该接口更新智能告警事件录像计划 | 查看文档去调试 |
UpdateRecordPlan | 调用该接口更新录像计划 | 查看文档去调试 |
DeleteRecordPlan | 调用该接口删除录像计划 | 查看文档去调试 |
DeleteRecordPlanDevice | 调用该接口删除IPC设备关联的录像计划 | 查看文档去调试 |
TriggerRecord![]() | 调用该接口立即触发指定IPC设备开始录像,并上传录像文件至云端 | 查看文档去调试 |
其他
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
QueryDevicePictureByList | 根据图片ID列表,获取图片地址 | 查看文档去调试 |
TransferDeviceInstance | 迁移设备所在的实例 | 查看文档去调试 |
QueryRecordDownloadUrl | 请求云端录像文件的下载地址 | 查看文档去调试 |
CreateLocalFileUploadJob | 调用该接口用于创建本地录像上传任务 | 查看文档去调试 |
DeleteLocalFileUploadJob | 调用该接口停止本地录像上传任务 | 查看文档去调试 |
QueryLocalFileUploadJob | 查询本地录像上传任务结果 | 查看文档去调试 |
QueryFaceUserBatch | 根据用户ID列表批量获取用户信息 | 查看文档去调试 |
QueryFaceUserByName | 通过人脸名称查找人脸数据 | 查看文档去调试 |
DeleteRecord | 删除云端存储的录像文件 | 查看文档去调试 |
QueryRecordUrlByTime | 获取指定时间范围内的录像文件的播放URL | 查看文档去调试 |
QueryCarProcessEvents | 调用该接口查询车辆作业的智能告警事件列表 | 查看文档去调试 |
DeletePicture | 调用该接口,批量删除指定IPC设备下指定图片ID的云端图片 | 查看文档去调试 |
其它
OpenAPI 名称 | 描述 | 操作 |
---|---|---|
UpdateInstanceInternetProtocol | 查看文档去调试 | |
CreateRecordDownloadByTimeJob | 查看文档去调试 | |
QueryRecordDownloadJobById | 查看文档去调试 | |
QueryRecordDownloadJobList | 查看文档去调试 | |
CreateLocalRecordDownloadByTimeJob | 查看文档去调试 | |
BatchQueryVisionDeviceInfo | 查看文档去调试 | |
CreateRtmpDevice | 查看文档去调试 | |
DeleteRtmpDevice | 查看文档去调试 | |
DeleteRtmpKey | 查看文档去调试 | |
QueryRtmpKey | 查看文档去调试 | |
QueryVisionDeviceInfo | 查看文档去调试 | |
UpdateRtmpKey | 查看文档去调试 | |
CreateGbDevice | 查看文档去调试 | |
DeleteGbDevice | 查看文档去调试 | |
EnableGbSubDevice | 查看文档去调试 | |
QueryGbSubDeviceList | 查看文档去调试 | |
RefreshGbSubDeviceList | 查看文档去调试 | |
UpdateGbDevice | 查看文档去调试 | |
CreateStreamPushJob | 查看文档去调试 | |
CreateStreamSnapshotJob | 查看文档去调试 | |
DeleteStreamPushJob | 查看文档去调试 | |
DeleteStreamSnapshotJob | 查看文档去调试 | |
QueryStreamPushJob | 查看文档去调试 | |
QueryStreamPushJobList | 查看文档去调试 | |
QueryStreamSnapshotJob | 查看文档去调试 |