# API概览 #### 认证管理 | 接口 | 说明 | |:---|:---| | POST /v2/{user_id}/enterprises/access-token | [获取用户北向接口认证AccessToken](https://support.huaweicloud.com/api-ivm/ivm_03_0002.html) | #### 设备组管理 | 接口 | 说明 | |:---|:---| | GET /v1/{user_id}/device-orgs/{device_org_id}/sub-orgs | [查询子级设备组织](https://support.huaweicloud.com/api-ivm/ivm_03_0004.html) | | GET /v1/{user_id}/device-orgs/{device_org_id}/devices | [查询企业下的组织的设备列表](https://support.huaweicloud.com/api-ivm/ivm_03_0032.html) | | PUT /v1/{user_id}/device-orgs/{device_org_id} | [修改设备分组名称](https://support.huaweicloud.com/api-ivm/ivm_03_0033.html) | | POST /v1/{user_id}/device-orgs | [添加设备分组](https://support.huaweicloud.com/api-ivm/ivm_03_0034.html) | | DELETE /v1/{user_id}/device-orgs/{device_org_id} | [删除单个设备组](https://support.huaweicloud.com/api-ivm/ivm_03_0035.html) | | POST /v1/{user_id}/device-orgs/{device_org_id}/move-devices | [移动多个设备到新的设备组](https://support.huaweicloud.com/api-ivm/ivm_03_0036.html) | | GET /v1/{user_id}/device-orgs/tree | [根据设备组名称查询设备组织树(支持设备组名称模糊查询)](https://support.huaweicloud.com/api-ivm/ivm_03_0037.html) | #### 设备管理 | 接口 | 说明 | |:---|:---| | GET /v1/{user_id}/devices/{device_id} | [用户根据设备ID查询设备信息详情](https://support.huaweicloud.com/api-ivm/ivm_03_0038.html) | | GET /v1/{user_id}/devices | [用户查询设备列表](https://support.huaweicloud.com/api-ivm/ivm_03_0039.html) | | GET /v1/{user_id}/devices/{device_id}/gateway | [查询设备网关（仅支持国标）](https://support.huaweicloud.com/api-ivm/ivm_03_0040.html) | | PUT /v1/{user_id}/devices/{device_id} | [修改设备信息](https://support.huaweicloud.com/api-ivm/ivm_03_0041.html) | | PUT /v1/{user_id}/devices/{device_id}/gb-account | [修改国标设备账号](https://support.huaweicloud.com/api-ivm/ivm_03_0042.html) | | POST /v1/{user_id}/devices/holosens | [添加好望设备](https://support.huaweicloud.com/api-ivm/ivm_03_0043.html) | | POST /v1/{user_id}/devices/gb/batch-add | [批量添加国标设备](https://support.huaweicloud.com/api-ivm/ivm_03_0044.html) | | POST /v1/{user_id}/devices/batch-delete | [批量删除设备](https://support.huaweicloud.com/api-ivm/ivm_03_0045.html) | #### 通道管理 | 接口 | 说明 | |:---|:---| | PUT /v1/{user_id}/devices/{device_id}/channels/{channel_id} | [修改通道信息](https://support.huaweicloud.com/api-ivm/ivm_03_0013.html) | | GET /v1/{user_id}/channels | [查询通道列表](https://support.huaweicloud.com/api-ivm/ivm_03_0046.html) | | GET /v1/{user_id}/devices/{device_id}/channels/{channel_id} | [查询通道详情](https://support.huaweicloud.com/api-ivm/ivm_03_0047.html) | #### 云台控制 | 接口 | 说明 | |:---|:---| | GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/control-lock | [获取云台控制权](https://support.huaweicloud.com/api-ivm/ivm_03_0027.html) | | POST /v1/{user_id}/devices/{device_id}/channels/{channel_id}/control-lock | [释放云台控制权](https://support.huaweicloud.com/api-ivm/ivm_03_0049.html) | | POST /v1/{user_id}/devices/{device_id}/channels/{channel_id}/ptz/angle-spin | [云台点动转动](https://support.huaweicloud.com/api-ivm/ivm_03_0051.html) | #### 媒体播放管理 | 接口 | 说明 | |:---|:---| | POST /v2/{user_id}/devices/channels/media/live-connections | [获取实况地址统一接口](https://support.huaweicloud.com/api-ivm/ivm_03_0052.html) | | GET /v2/{user_id}/devices/{device_id}/channels/{channel_id}/media/records | [查询回放列表统一接口](https://support.huaweicloud.com/api-ivm/ivm_03_0053.html) | | GET /v2/{user_id}/devices/{device_id}/channels/{channel_id}/media/playback-connections | [获取回放地址统一接口](https://support.huaweicloud.com/api-ivm/ivm_03_0054.html) | | POST /v1/{user_id}/media/urls/batch-delete | [批量删除播放地址](https://support.huaweicloud.com/api-ivm/ivm_03_0055.html) | | GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/cloud-records | [【旧】查询通道的云端录像列表](https://support.huaweicloud.com/api-ivm/ivm_03_0056.html) | | GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/cloud-records/playback-url | [【旧】查询通道的云端录像回放地址](https://support.huaweicloud.com/api-ivm/ivm_03_0057.html) | | GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/device-records | [【旧】查询通道的前端录像列表](https://support.huaweicloud.com/api-ivm/ivm_03_0058.html) | | GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/device-records/playback-url | [【旧】查询通道的前端录像回放地址（仅支持国标协议）](https://support.huaweicloud.com/api-ivm/ivm_03_0059.html) | | GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/device-records/web-playback-url | [【旧】查询通道的前端录像回放地址](https://support.huaweicloud.com/api-ivm/ivm_03_0060.html) | | POST /v1/{user_id}/devices/channels/cloud-live/url | [【旧】批量获取设备实况播放地址](https://support.huaweicloud.com/api-ivm/ivm_03_0143.html) | | POST /v1/{user_id}/devices/channels/p2p-connect/live | [【旧】批量获取通道实况P2P地址（仅支持好望协议）](https://support.huaweicloud.com/api-ivm/ivm_03_0062.html) | | POST /v1/{user_id}/devices/channels/p2p-connect/playback | [【旧】批量获取通道录像回放P2P地址（仅支持好望协议）](https://support.huaweicloud.com/api-ivm/ivm_03_0063.html) | #### 行业数据流管理-消息管理 | 接口 | 说明 | |:---|:---| | POST /v1/{user_id}/messages/callback | [配置用户消息通知URL](https://support.huaweicloud.com/api-ivm/ivm_03_0064.html) | | DELETE /v1/{user_id}/messages/callback | [删除用户消息通知URL](https://support.huaweicloud.com/api-ivm/ivm_03_0065.html) | | GET /v1/{user_id}/messages/callback | [查询用户消息通知URL](https://support.huaweicloud.com/api-ivm/ivm_03_0066.html) | #### 行业数据流管理-图片下载 | 接口 | 说明 | |:---|:---| | POST /v1/{user_id}/intelligence-data/pictures | [批量获取智能图片下载路径](https://support.huaweicloud.com/api-ivm/ivm_03_0081.html) | | POST /v1/{user_id}/alarms/pictures | [批量获取智能告警图片下载路径](https://support.huaweicloud.com/api-ivm/ivm_03_0082.html) | #### 行业数据流管理-云端抓拍 | 接口 | 说明 | |:---|:---| | GET /v1/{user_id}/devices/snap | [云端抓拍设备图片](https://support.huaweicloud.com/api-ivm/ivm_03_0084.html) | #### 行业数据流管理-智能统计 | 接口 | 说明 | |:---|:---| | GET /v1/{user_id}/statistics/people | [查询客流统计信息](https://support.huaweicloud.com/api-ivm/ivm_03_0086.html) | | GET /v1/{user_id}/time-heatmap | [获取时间热度图统计](https://support.huaweicloud.com/api-ivm/ivm_03_0087.html) | | GET /v1/{user_id}/space-heatmap | [获取空间热度图统计](https://support.huaweicloud.com/api-ivm/ivm_03_0088.html) | #### 录像配置管理 | 接口 | 说明 | |:---|:---| | PUT /v1/{user_id}/devices/channels/record-plan | [批量为通道设置录像计划](https://support.huaweicloud.com/api-ivm/ivm_03_0092.html) | | POST /v1/{user_id}/devices/channels/record-plan | [批量删除通道录像计划](https://support.huaweicloud.com/api-ivm/ivm_03_0093.html) | | GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/record-plan | [查询通道的录像计划](https://support.huaweicloud.com/api-ivm/ivm_03_0091.html) | | GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/time-policy | [查询通道存储时间策略](https://support.huaweicloud.com/api-ivm/ivm_03_0094.html) | | PUT /v1/{user_id}/devices/channels/record-config | [批量设置通道录像参数](https://support.huaweicloud.com/api-ivm/ivm_03_0090.html) | | GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/record-config | [查询通道录像参数](https://support.huaweicloud.com/api-ivm/ivm_03_0089.html) | | PUT /v1/{user_id}/devices/channels/time-policy | [批量设置通道存储时间策略](https://support.huaweicloud.com/api-ivm/ivm_03_0095.html) | | PUT /v1/{user_id}/devices/channels/record-alarm-plan | [批量设置通道动检录像计划](https://support.huaweicloud.com/api-ivm/ivm_03_0097.html) | | GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/record-alarm-plan | [查询通道的动检录像计划](https://support.huaweicloud.com/api-ivm/ivm_03_0096.html) | #### 智能图片下载 | 接口 | 说明 | |:---|:---| | POST /v1/{user_id}/intelligence-data/pictures | [批量获取智能图片下载路径](https://support.huaweicloud.com/api-ivm/ivm_03_0081.html) | #### 服务开通关闭管理 | 接口 | 说明 | |:---|:---| | POST /v1/{user_id}/devices/channels/resources | [批量开通设备通道服务](https://support.huaweicloud.com/api-ivm/ivm_03_0098.html) | | DELETE /v1/{user_id}/devices/channels/resources | [批量关闭设备通道服务](https://support.huaweicloud.com/api-ivm/ivm_03_0099.html) | #### 资源管理 | 接口 | 说明 | |:---|:---| | GET /v1/{user_id}/resources | [查询包周期和按需资源列表](https://support.huaweicloud.com/api-ivm/ivm_03_0100.html) | | GET /v1/{user_id}/resources/{resource_id}/channels | [查询包周期或按需资源下的通道列表](https://support.huaweicloud.com/api-ivm/ivm_03_0101.html) | | GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/resources | [查询通道下的资源列表](https://support.huaweicloud.com/api-ivm/ivm_03_0102.html) | #### 告警图片下载 | 接口 | 说明 | |:---|:---| | POST /v1/{user_id}/alarms/pictures | [传入告警分类及告警ID数据生成图片下载路径列表](https://support.huaweicloud.com/api-ivm/ivm_03_0082.html) | #### 目标库 | 接口 | 说明 | |:---|:---| | POST /v1/{user_id}/target/batch-delete | [删除目标信息](https://support.huaweicloud.com/api-ivm/ivm_03_0115.html) | | PUT /v1/{user_id}/targets | [批量修改目标信息](https://support.huaweicloud.com/api-ivm/ivm_03_0114.html) | | POST /v1/{user_id}/targets/batch-add | [目标批量添加](https://support.huaweicloud.com/api-ivm/ivm_03_0113.html) | | GET /v1/{user_id}/targets/ids | [按索引范围获取目标ID列表](https://support.huaweicloud.com/api-ivm/ivm_03_0111.html) | | GET /v1/{user_id}/target-groups | [获取目标库分组](https://support.huaweicloud.com/api-ivm/ivm_03_0103.html) | | POST /v1/{user_id}/target-groups | [新增目标库分组](https://support.huaweicloud.com/api-ivm/ivm_03_0104.html) | | PUT /v1/{user_id}/target-groups | [修改目标库分组](https://support.huaweicloud.com/api-ivm/ivm_03_0106.html) | | DELETE /v1/{user_id}/target-groups | [删除目标库分组](https://support.huaweicloud.com/api-ivm/ivm_03_0108.html) | | POST /v2/{user_id}/target-groups | [新增目标库分组v2](https://support.huaweicloud.com/api-ivm/ivm_03_0105.html) | | PUT /v2/{user_id}/target-groups | [修改目标库分组v2](https://support.huaweicloud.com/api-ivm/ivm_03_0107.html) | | DELETE /v2/{user_id}/target-groups | [删除目标库分组v2](https://support.huaweicloud.com/api-ivm/ivm_03_0109.html) | | GET /v1/{user_id}/targets | [按索引范围获取目标信息列表](https://support.huaweicloud.com/api-ivm/ivm_03_0122.html) | | POST /v1/{user_id}/targets | [获取目标信息（IVS1800不支持）](https://support.huaweicloud.com/api-ivm/ivm_03_0110.html) | | GET /v1/{user_id}/targets/count | [获取目标库分组中的目标数量](https://support.huaweicloud.com/api-ivm/ivm_03_0112.html) | #### 巡航轨迹和预置位 | 接口 | 说明 | |:---|:---| | GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/cruise-track/list | [获取巡航轨迹列表](https://support.huaweicloud.com/api-ivm/ivm_03_0121.html) | | DELETE /v1/{user_id}/devices/{device_id}/channels/{channel_id}/preset-position | [删除摄像机预置位](https://support.huaweicloud.com/api-ivm/ivm_03_0118.html) | | PUT /v1/{user_id}/devices/{device_id}/channels/{channel_id}/cruise-track | [修改摄像机巡航轨迹](https://support.huaweicloud.com/api-ivm/ivm_03_0126.html) | | POST /v1/{user_id}/devices/{device_id}/channels/{channel_id}/cruise-track | [添加摄像机巡航轨迹](https://support.huaweicloud.com/api-ivm/ivm_03_0124.html) | | POST /v1/{user_id}/devices/{device_id}/channels/{channel_id}/preset-position | [添加摄像机预置位](https://support.huaweicloud.com/api-ivm/ivm_03_0117.html) | | GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/cruise-track | [查询指定巡航轨迹详情](https://support.huaweicloud.com/api-ivm/ivm_03_0123.html) | | PUT /v1/{user_id}/devices/{device_id}/channels/{channel_id}/cruise-track/enable | [启停摄像机巡航轨迹](https://support.huaweicloud.com/api-ivm/ivm_03_0127.html) | | DELETE /v1/{user_id}/devices/{device_id}/channels/{channel_id}/cruise-track | [删除摄像机巡航轨迹](https://support.huaweicloud.com/api-ivm/ivm_03_0125.html) | | PUT /v1/{user_id}/devices/{device_id}/channels/{channel_id}/preset-position | [修改摄像机预置位](https://support.huaweicloud.com/api-ivm/ivm_03_0119.html) | | POST /v1/{user_id}/devices/{device_id}/channels/{channel_id}/preset-position/move | [移动摄像机转到预置位](https://support.huaweicloud.com/api-ivm/ivm_03_0120.html) | | GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/preset-position | [查询摄像机预置位列表](https://support.huaweicloud.com/api-ivm/ivm_03_0116.html) | #### 查询设备码流能力和码流列表 | 接口 | 说明 | |:---|:---| | GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/stream-ability | [查询设备码流能力和码流列表](https://support.huaweicloud.com/api-ivm/ivm_03_0130.html) | | GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/stream-detail | [查询设备码流详情，目前仅支持好望设备](https://support.huaweicloud.com/api-ivm/ivm_03_0131.html) | | POST /v1/{user_id}/devices/{device_id}/channels/{channel_id}/stream-detail | [设备码流配置](https://support.huaweicloud.com/api-ivm/ivm_03_0132.html) | #### 设备密码修改 | 接口 | 说明 | |:---|:---| | GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/security-key | [查询设备密码状态，仅支持好望SDC直连设备](https://support.huaweicloud.com/api-ivm/ivm_03_0128.html) | | PUT /v1/{user_id}/devices/{device_id}/channels/{channel_id}/security-key | [设置或修改设备密码，仅支持好望SDC直连设备](https://support.huaweicloud.com/api-ivm/ivm_03_0129.html) | #### 设备目标授权配置 | 接口 | 说明 | |:---|:---| | PUT /v1/{user_id}/devices/{device_id}/channels/targets/authorization | [批量设置通道目标授权状态，只支持好望设备](https://support.huaweicloud.com/api-ivm/ivm_03_0134.html) | | GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/targets/authorization | [查询设备目标授权状态，仅支持好望设备](https://support.huaweicloud.com/api-ivm/ivm_03_0133.html) | #### 云上能力集管理 | 接口 | 说明 | |:---|:---| | POST /v1/{user_id}/devices/ability | [批量查询版本能力集](https://support.huaweicloud.com/api-ivm/ivm_03_0135.html) |