华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken，从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 direction 是 String 方向：枚举类型 枚举值： LEFT 左转 UP 上转 RIGHT 右转 DOWN 下转 UPPER_LEFT 左上转动（设备10.0以上版本支持） UPPER_RIGHT 右上转动（设备10.0以上版本支持） LOWER_LEFT 左下转动（设备10.0以上版本支持） LOWER_RIGHT 右下转动（设备10.0以上版本支持） STOP 停止八向转动及变焦，其中停止变焦不支持直连摄像机（除E系列） IN 变焦放大 OUT 变焦缩小 ZOOM_STOP 变焦停止，所有云台设备都支持 FOCUS_FAR 聚焦变远 FOCUS_NEAR 聚焦变近 AUTO_FOCUS 自动聚焦（设备10.0以上版本支持） IRIS_OPEN 光圈变大 IRIS_CLOSE 光圈变小 FI_STOP 光圈和聚焦停止 control_lock 是 String 设备操作token不能为空（从获取云台控制权接口获取），token获取后只要进行云台控制操作就能够进行续签，不需要一直获取云台控制权 speed 否 Integer 速度，取值范围[1,10]，非必填，默认是10 mode 否 String 点动模式：默认方式，注：好望摄像机以华为协议接入的时候，变焦和聚焦时，需手动单击停止，否则会一直放大或者缩小。以onvif协议接入时，变焦和聚焦后则会自动停止 转动模式：枚举类型，非必填，国标设备只能使用转动模式，直连摄像机（除E系列）聚焦和变焦功能只能使用转动模式 枚举值： POINT 点动模式 NON_POINT 转动模式 heartbeat_mode 否 String 心跳模式：枚举类型，默认为关，只有E系列摄像机有用，心跳模式能够帮助E系列摄像机一直维持转动 枚举值： OPEN 开启心跳模式 CLOSE 关闭心跳模式

功能介绍 云台控制，支持好望、国标设备云台八向转动、点动，变焦，光圈，聚焦等能力 点动模式：只要调用一次云台移动相关命令（即direction填了除了STOP、FI_STOP、ZOOM_STOP和AUTO_FOCUS以外的参数），不需要调用STOP命令后会自动停止 转动模式：调用云台移动相关命令后（即direction填了除了STOP、FI_STOP、ZOOM_STOP和AUTO_FOCUS以外的参数），设备会一直不停转动，一直到发送STOP命令后才会停止 因华为SDC本身限制，云台控制指令短时间内无法接收过多，否则导致崩溃或连续转动，连续命令触发间隔应≥300ms

URI POST /v1/{user_id}/devices/{device_id}/channels/{channel_id}/ptz/angle-spin 表1 路径参数 参数 是否必选 参数类型 描述 channel_id 是 String 通道ID： 好望设备：取值范围[0,999] 国标设备：由数字组成，长度为20个字符，由客户自行在设备侧设置，可以在web界面获取 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节

请求示例 通过版本查询设备能力集 POST /v1/2562572829***/devices/ability { "versions" : [ { "device_type" : "IPC", "model" : "C3050-10-LI-PV(3.6mm)", "firmware" : "SDC 10.0.RC11" }, { "device_type" : "IPC", "model" : "C3050-10-LI-PV(3.6mm)", "firmware" : "SDC 10.0.RC12" } ], "need_specification" : true, "ability" : [ "ptz", "soundlightalarm" ] }

响应示例 状态码： 200 OK { "abilities" : [ { "device_type" : "IPC", "firmware" : "SDC 10.0.RC11", "model" : "C3050-10-LI-PV(3.6mm)", "abilities" : { "ptz" : { "support" : false }, "soundlightalarm" : { "alarm_voice_file_max_num" : "6", "alarm_voice_one_file_max_size" : "76800", "alarm_voice_file_max_size" : "524288", "support" : false } } }, { "device_type" : "IPC", "firmware" : "SDC 10.0.RC12", "model" : "C3050-10-LI-PV(3.6mm)", "abilities" : { "ptz" : { "support" : false }, "soundlightalarm" : { "support" : false } } } ] }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 abilities Array of DeviceVersionAndAbilities objects 设备版本对应能力集返回体 表6 DeviceVersionAndAbilities 参数 参数类型 描述 device_type String 设备类型 model String 设备款型 firmware String 设备软件版本 abilities Object 设备能力集规格

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 versions 是 Array of versions objects 设备版本 need_specification 否 Boolean 是否需要返回具体规格，不传默认false ability 否 Array of strings 查询的云上能力集列表，不传默认查询所有能力集 表4 versions 参数 是否必选 参数类型 描述 device_type 是 String 设备类型，必填，可以通过用户根据设备ID查询设备信息详情获取 firmware 是 String 设备软件版本，必填，可以通过用户根据设备ID查询设备信息详情获取 model 是 String 设备固件类型（设备款型），必填，可以通过用户根据设备ID查询设备信息详情获取

URI POST /v1/{user_id}/devices/{device_id}/channels/{channel_id}/preset-position 表1 路径参数 参数 是否必选 参数类型 描述 channel_id 是 String 通道ID校验：目前只支持好望设备，取值范围[-1,999] device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 preset_name 是 String 预置位名称：数字、中文、英文、空格、-、_，.，长度范围[1,128] index 否 Integer 预置位序号：直连设备必传，非直连场景不传。取值范围[1,512]

URI PUT /v1/{user_id}/devices/{device_id} 表1 路径参数 参数 是否必选 参数类型 描述 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 device_name 否 String 设备名称：字符组成，支持数字、中文（一个汉字算两个字符）、英文大小写、空格、-、_，长度范围[1,128] description 否 String 设备描述：字符组成，支持数字、中文（一个汉字算两个字符）、英文大小写、空格、-、_，长度范围[1,128] modify_type 否 String 修改类型：枚举类型，默认值DEFAULT。 好望设备不检测该参数 枚举值： DEFAULT 国标协议接入设备按参数device_name修改设备名称和osd，仅设备在线可修改。此时需要device_name字段有值 OSD 设备osd修改，仅支持国标协议接入的设备，仅设备在线可修改。此时需要参数osd字段有值 DEVICE_NAME 设备名称修改，仅支持国标协议接入的设备，无论设备什么状态均可修改。此时需要参数device_name字段有值 ALL 分别按device_name和osd修改，仅支持国标协议接入的设备，仅设备在线可修改。此时参数osd、参数device_name字段均需有值 osd 否 String osd内容：长度范围[1,63]，一个中文占3个字节 说明： 在modify_type为DEFAULT或者DEVICE_NAME时忽略此参数。

响应示例 状态码： 200 OK { "devices" : [ { "device_id" : "952352LWXT***", "device_name" : "好望设备", "device_state" : "UNREGISTERED", "device_type" : "IPC", "device_system_state" : "NORMAL", "access_protocol" : "HOLO", "manufacture" : "HUAWEI", "device_ability" : "ptz", "channel_total" : "1", "channels" : [ { "channel_resource_state" : [ "MANAGEMENT_GRANT", "INDUSTRY_DATA_GRANT", "FULL_RECORD_GRANT", "EVENT_RECORD_CLOSED" ], "channel_state" : "ONLINE", "channel_system_state" : "NORMAL", "channel_id" : "0", "channel_name" : "好望通道", "invalid_type" : "NORMAL" } ], "operator_total" : "0", "create_time" : "2020-09-01 17:09:12", "update_time" : "2020-12-30 09:30:31", "device_org_name" : "好望设备组" } ], "total" : 1, "device_total" : 1, "admin_total" : 0, "online_total" : 0 }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 devices Array of InnerDeviceInfoMuti objects 设备列表 total Integer 查询条数 device_total Integer 设备总数 admin_total Integer 管理员总数 online_total Integer 在线设备数 表5 InnerDeviceInfoMuti 参数 参数类型 描述 device_id String 设备ID，设备唯一标识符 device_name String 设备名称 device_state String 设备状态 枚举值： OFFLINE 离线 ONLINE 在线 UNREGISTERED 未注册 device_type String 设备类型 枚举值： IPC 直连摄像机 NVR NVR设备 MEdge IVS1800设备 device_system_state String 设备系统冻结 枚举值： NORMAL 正常 UNAVAILABLE_FROZEN 冻结 access_protocol String 接入协议类型 枚举值： HOLO 好望协议 GB28181 国标协议 manufacture String 生产厂家 device_ability String 设备能力集：枚举类型，参考附录设备能力集，多个能力集用英文逗号分隔 channel_total Integer 通道总数 channels Array of InnerChannelInfo objects 通道信息 operator_total Integer 该设备绑定的普通用户总数 model String 设备型号 create_time String 设备添加时间 update_time String 设备更新时间，在设备重新上线后或者移动设备分组后会修改时间 device_org_name String 设备组织名称 frimware String 设备版本 channel_allocated_total Integer 已分配通道总数 channel_online_count Integer 在线通道总数 audio_input_cnt Integer 音频输入通道个数 audio_output_cnt Integer 音频输出通道个数 gb_access_state String 国标设备未上线原因 枚举值 NOT_CONNECTED：云服务未收到设备信息 NO_AUTHENTICATION_INFO：云服务接受设备信息不全 AUTHENTICATION_FAILED：鉴权失败 CATA LOG _ERROR：未收到正确的通道信息 UNKNOWN_ERROR：未知错误 CONNECTED：已连接 表6 InnerChannelInfo 参数 参数类型 描述 channel_resource_state Array of strings 通道资源列表：一个通道可以存在多个套餐，枚举类型 枚举值： MANAGEMENT_GRANT 管理套餐开通 MANAGEMENT_ARREAR 管理套餐欠费 MANAGEMENT_CLOSED 管理套餐未开通 EVENT_RECORD_GRANT 动检套餐开通 EVENT_RECORD_ARREAR 动检套餐欠费 EVENT_RECORD_CLOSED 动检套餐关闭 FULL_RECORD_GRANT 全量套餐开通 FULL_RECORD_ARREAR 全量套餐欠费 FULL_RECORD_CLOSED 全量套餐关闭 INDUSTRY_DATA_GRANT 行业数据流套餐开通 INDUSTRY_DATA_ARREAR 行业数据流套餐欠费 INDUSTRY_DATA_CLOSED 行业数据流套餐关闭 channel_state String 通道状态：枚举类型 枚举值： OFFLINE 离线 ONLINE 在线 UNREGISTERED 未注册 channel_system_state String 设备系统状态：枚举类型 枚举值： NORMAL 正常 UNAVAILABLE_FROZEN 冻结 channel_id String 通道ID channel_name String 通道名称 channel_model String 通道的设备型号 channel_mode String 通道的设备型号，此字段已废弃，不推荐使用，建议使用channel_model字段代替 invalid_type String 通道无效类型：枚举类型 枚举值： NORMAL 正常 CHANNEL_ID_INVALID 通道ID无效 channel_ability String 通道能力集 storage_card_status String SD卡状态 枚举类型： 0-卡存在且运行正常 1-卡存在但是异常需要格式化 2-卡不存在 3-格式化中 -1-设备不支持 mask_mode String 隐私遮蔽开关状态 枚举类型： OPEN-开 CLOSE-关

URI GET /v1/{user_id}/device-orgs/{device_org_id}/devices 表1 路径参数 参数 是否必选 参数类型 描述 device_org_id 是 String 设备组织ID：由数字组成，长度范围[1,25]，根组织节点的值为0，可以从查询子级设备组织获取 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节 表2 Query参数 参数 是否必选 参数类型 描述 access_protocol 否 String 接入协议：枚举类型，多个查询使用英文逗号分隔 枚举值： HOLO 好望协议 GB28181 国标协议 channel_resource_state 否 String 通道资源状态：枚举类型，多个查询使用英文逗号分隔 枚举值： MANAGEMENT_GRANT 管理套餐开通 MANAGEMENT_ARREAR 管理套餐欠费 MANAGEMENT_CLOSED 管理套餐未开通 EVENT_RECORD_GRANT 动检套餐开通 EVENT_RECORD_ARREAR 动检套餐欠费 EVENT_RECORD_CLOSED 动检套餐关闭 FULL_RECORD_GRANT 全量套餐开通 FULL_RECORD_ARREAR 全量套餐欠费 FULL_RECORD_CLOSED 全量套餐关闭 INDUSTRY_DATA_GRANT 行业数据流套餐开通 INDUSTRY_DATA_ARREAR 行业数据流套餐欠费 INDUSTRY_DATA_CLOSED 行业数据流套餐关闭 ability 否 String 设备能力：枚举类型，仅支持单个能力集查询 枚举值： algorithm 算法能力 ptz 云台能力 device_id 否 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型 device_name 否 String 模糊查询字段：支持设备名称模糊匹配，由字符组成，支持数字、中文（一个汉字算两个字符）、英文、-、_、空格，长度范围[1,128] device_state 否 String 设备状态：枚举类型，多个查询使用英文逗号分隔 枚举值： OFFLINE 离线 ONLINE 在线 UNREGISTERED 未注册 device_system_state 否 String 设备系统状态：枚举类型，多个查询使用英文逗号分隔 枚举值： NORMAL 正常 UNAVAILABLE_FROZEN 冻结 device_type 否 String 设备类型：枚举类型，多个查询使用英文逗号分隔 枚举值： IPC 直连摄像机 NVR NVR设备 MEdge IVS1800设备 direction 否 String 排序方向：枚举类型，默认降序，不区分大小写 枚举值： ASC 升序 DESC 降序 group_ids 否 String 所属分组ID列表：支持多个设备组织查询，使用英文逗号分隔 单个设备组织ID：由数字组成，长度范围[1,25]（根组织节点的值为0） is_current_org 否 String 是否属于当前组织：枚举类型，不填就是查询全部组织 枚举值： 0 下级组织 1 当前组织 2 所有组织 limit 否 Integer 限制条数：取值范围[0,1000]，不填写时默认值为10 manufactures 否 String 厂商：支持多个厂商查询，使用英文逗号隔开 单个厂商：由中文（一个汉字算两个字符）、英文、数字 、特殊字符（_-空格）组成，长度范围[1,64] offset 否 Integer 偏移量页数：0为第一页，取值范围[0,2147483646]，不填写时默认为0 sort_by 否 String 排序字段：枚举类型，默认按创建时间create_time排序 枚举值： create_time 创建时间 update_time 更新时间 operator_total 拥有该设备的普通用户总数 user_order 否 Integer 排序字段：枚举类型，按用户数排序（当前无效） 枚举值： 0 数量从小到大 1 数量从大到小

请求示例 获取实况地址请求： POST /v2/123456789*****/devices/channels/media/live-connections { "expire_time":30, "use_times":0, "channels": [ { "channel_id": "0", "device_id": "219123456CYP***", "live_protocol":"HOLO", "stream_type": "SECONDARY_STREAM_1" }, { "channel_id": "1", "device_id": "219123456CYP***", "live_protocol":"HOLO", "stream_type": "PRIMARY_STREAM" } ] }

响应示例 状态码： 200 OK { "fail_num": 1, "live_connections": [ { "device_id": "219123456CYP***", "channel_id": "0", "cloud_trans_connections": {}, "p2p_connections": {}, "result": { "code": "IVM.10026004", "msg": "The param stream_type is not support." } }, { "device_id": "210123456SMY***", "channel_id": "0", "cloud_trans_connections": { "live_url": "jvmp://123.123.123.123:7070/live/210123456SMY***?token=content***" }, "p2p_connections": { "token": "content***", "device_state": "ONLINE", "p2p_nodes": [ { "node_type": "COMMON", "address_type": "IPV4", "address": [ "123.123.123.123" ], "tcp_port": 0, "udp_port": 7050 } ] }, "result": { "code": "IVM.0", "msg": "Success" } } ] }

响应参数 状态码： 200 表5 响应Body参数：播放P2P实况需要将响应Body参数中的所有内容输入到播放地址栏 参数 参数类型 描述 fail_num Integer 获取设备url失败的数量 live_connections Array of LiveConnectionResp objects 实况响应信息 表6 LiveConnectionResp 参数 参数类型 描述 device_id String 设备ID：设备唯一标识，长度范围[1,32] channel_id String 通道ID：长度范围[1,20] cloud_trans_connections CloudTransChannelsResp object 转发实况连接结构体 p2p_connections P2PChannelsResp object P2P实况连接结构体：仅支持HOLO媒体播放协议且请求设备为好望设备 result Result object 错误信息 表7 CloudTransChannelsResp 参数 参数类型 描述 live_url String 转发实况播放地址：将此url输入播放地址栏开始播放 表8 P2PChannelsResp 参数 参数类型 描述 token String P2P请求Token device_state String 在线状态：枚举类型 枚举值： OFFLINE 离线 ONLINE 在线 p2p_nodes Array of P2PMTSListResp objects P2P连接可用节点 表9 P2PMTSListResp 参数 参数类型 描述 node_type String 节点类型：枚举类型 枚举值： COMMON 普通：普通的三线（移动，联通，电线）服务器，与地域有关，服务器由运营商托管，网络通信质量低 BETTER 优质：全网通服务器（华为云服务器等），网络通信质量高 address_type String 地址类型：枚举类型 DOMAIN 域地址 IPV4 IPv4地址 IPV6 IPv6地址 address Array of strings 媒体转发服务地址： 协议头在SDK封装 ，根据address_type决定地址类型 DOMAIN: www.huawei.com IPV4: 123.123.123.123 IPV6: fe80::f816:3eff:feed:5821 tcp_port Integer TCP端口：默认值为 0 备注：未使用0端口，tcp_port只作为兼容字段保留 udp_port Integer UDP端口：默认值为 7050 表10 Result 参数 参数类型 描述 code String 错误编码：请参见错误码 msg String 错误信息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 channels 是 Array of ChannelsLiveParamV2 objects 请求信息V2 expire_time 否 Integer 自定义Url过期时间：时间范围[30, 86400]，不传默认为 30（单位/秒） 备注：仅对CloudTransChannelsResp中的live_url有效 use_times 否 Integer 自定义Url使用次数：枚举类型，不填写时默认值为 0，RTSP协议固定为 0 备注：仅对CloudTransChannelsResp中的live_url有效 枚举值： 0 使用一次 1 有效时间内任意使用，此参数对RTSP协议无效 表4 ChannelsLiveParamV2 参数 是否必选 参数类型 描述 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度固定为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型 channel_id 是 String 通道ID： 好望设备：取值范围[0,999] 国标设备：由数字组成，长度为20个字符，由客户自行在设备侧设置，可以在web界面获取 live_protocol 是 String 媒体播放协议：枚举类型，选择获取地址的媒体播放协议类型 枚举值： HOLO 好望协议 HTTP_HLS 基于HTTP的HLS流媒体传输协议 HTTPS_HLS 基于HTTPS的HLS流媒体传输协议 HTTP_FLV 基于HTTP的FLV媒体协议 HTTPS_FLV 基于HTTPS的FLV媒体协议 RTSP RTSP流媒体传输协议 stream_type 是 String 码流类型：枚举类型 枚举值： PRIMARY_STREAM 主码流 SECONDARY_STREAM_1 子码流1 SECONDARY_STREAM_2 子码流2

设备目标授权配置 接口 说明 PUT /v1/{user_id}/devices/{device_id}/channels/targets/authorization 批量设置通道目标授权状态，只支持好望设备 GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/targets/authorization 查询设备目标授权状态，仅支持好望设备

设备密码修改 接口 说明 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直连设备

目标库 接口 说明 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}/resources 查询包周期和按需资源列表 GET /v1/{user_id}/resources/{resource_id}/channels 查询包周期或按需资源下的通道列表 GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/resources 查询通道下的资源列表

查询设备码流能力和码流列表 接口 说明 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}/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 查询摄像机预置位列表

录像配置管理 接口 说明 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 查询通道的动检录像计划

云台控制 接口 说明 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地址（仅支持好望协议）

设备组管理 接口 说明 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 批量删除设备

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 verification_code 是 String 验证码：支持大小写字母、数字，长度固定为8位 description 否 String 设备描述：字符组成，长度范围[0,128]