华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 devices 是 Array of strings 要移动设备ID集合：数组长度范围[1,100] 单个设备： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 failed_num Integer 失败数量 devices Array of BatchAddGBDevicesRespItem objects 添加结果详细信息 表6 BatchAddGBDevicesRespItem 参数 参数类型 描述 device_id String 设备ID，设备唯一标识符 sip_server_id String SIP服务器ID sip_server_domain String SIP服务器域 sip_server_host String SIP服务器地址 sip_server_port String SIP服务器端口 result Result object 错误或成功信息 表7 Result 参数 参数类型 描述 code String 错误编码 msg String 错误信息

请求示例 添加国标协议设备 POST /v1/2562572829***/devices/gb/batch-add { "devices" : [ { "device_id" : "952352LWXT***", "device_name": "DEVICE01", "device_username" : "admin", "device_password" : "***", "algorithm": "MD5" } ] }

响应示例 状态码： 200 OK { "failed_num" : 0, "devices" : [ { "device_id" : "952352LWXT***", "sip_server_id" : "3402000000***", "sip_server_domain" : "3402***", "sip_server_host" : "123.123.*.*", "sip_server_port" : "5060", "result" : { "code" : "IVM.0", "msg" : "Success" } } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 device_id String 设备ID，设备唯一标识符 device_name String 设备名称 device_type String 设备类型 枚举值 IPC 通用相机 NVR NVR设备 MEdge IVS1800设备 IPC-BULLET 枪机 IPC-BOX 筒机 IPC-CONCH 半球/海螺 IPDOME 球机 device_state String 设备状态 枚举值： OFFLINE 离线 ONLINE 在线 manufacture String 设备生产厂商

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

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

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 { "device_id" : "952352LWXT***", "device_username" : "admin", "sip_server_id" : "3402000000***", "sip_server_domain" : "3402***", "sip_server_host" : "123.123.*.*", "sip_server_port" : 5060 }

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 device_username String sip服务器用户名 sip_server_id String SIP服务器ID sip_server_domain String SIP服务器域 sip_server_host String SIP服务器地址 sip_server_port String SIP服务器端口 device_id String 设备ID：由数字组成，长度为20个字符长度

响应示例 状态码： 200 OK { "total" : 2, "devices" : [ { "device_id" : "952352DJNR***", "device_name" : "测试设备", "device_state" : "ONLINE", "device_system_state" : "NORMAL", "device_type" : "IPC", "manufacture" : "jovision", "device_ability" : "ptz,talk", "device_cloud_ability": { "alarm_voice": { "support": "true" }}, "access_protocol" : "HOLO", "channel_total" : 1, "channel_online_total" : 1, "channel_offline_total" : 0, "sdk_ability" : "***", "org_list" : { "device_org_id" : "1234567890***", "device_org_name" : "测试设备组织**", "device_org_level" : "1" }, "create_time" : "2020-06-26 20:42:16", "update_time" : "2020-06-26 20:42:16" }, { "device_id" : "952352LWXT***", "device_name" : "测试设备1", "device_state" : "ONLINE", "device_system_state" : "NORMAL", "device_type" : "IPC", "manufacture" : "jovision", "device_ability" : "ptz,talk", "device_cloud_ability": { "alarm_voice": { "support": "true" }}, "access_protocol" : "HOLO", "channel_total" : 1, "channel_online_total" : 1, "channel_offline_total" : 0, "sdk_ability" : "***", "org_list" : { "device_org_id" : "1234567890***", "device_org_name" : "测试设备组织**", "device_org_level" : "1" }, "create_time" : "2020-06-26 20:42:16", "update_time" : "2020-06-26 20:42:16" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 devices Array of DeviceInfoMuti objects 设备列表 total Integer 查询条数 表5 DeviceInfoMuti 参数 参数类型 描述 device_id String 设备ID，设备唯一标识符 device_name String 设备名称 device_state String 设备状态 枚举值： OFFLINE 离线 ONLINE 在线 UNREGISTERED 未注册 device_type String 设备类型 枚举值： IPC 通用相机 NVR NVR设备 MEdge IVS1800设备 IPC-BULLET 枪机 IPC-BOX 筒机 IPC-CONCH 半球/海螺 IPDOME 球机 device_system_state String 设备系统冻结 枚举值： NORMAL 正常 UNAVAILABLE_FROZEN 冻结 create_time String 创建时间 update_time String 更新时间，在设备重新上线后或者移动设备分组后会修改时间 access_protocol Integer 接入协议类型 manufacture String 生产厂家 device_ability String 设备能力集：枚举类型，参考附录设备能力集，多个能力集用英文逗号分隔 device_cloud_ability Object 云端能力集规格 channel_total Integer 通道总数 channel_online_total Integer 通道在线总数 channel_offline_total Integer 通道离线总数 org_list Array of 表6 DeviceOrgInfo objects 设备组结果 sdk_ability String sdk能力集 表6 DeviceOrgInfo 参数 参数类型 描述 device_org_id String 设备组织ID device_org_name String 设备组织名称 device_org_level Integer 设备组织层级

URI GET /v1/{user_id}/devices 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节 表2 Query参数 参数 是否必选 参数类型 描述 access_protocol 否 String 接入协议：枚举类型，多个使用英文逗号分隔 枚举值： HOLO 好望协议 GB28181 国标协议 device_name 否 String 模糊查询字段：支持设备名称模糊匹配，由字符组成，支持数字、中文（一个汉字算两个字符）、英文、-、_、空格，长度范围[0,128] device_state 否 String 设备状态：枚举类型，多个查询使用英文逗号分隔 枚举值： OFFLINE 离线 ONLINE 在线 UNREGISTERED 未注册 device_system_state 否 String 设备系统状态：枚举类型，多个查询使用英文逗号分隔 枚举值： NORMAL 正常 UNAVAILABLE_FROZEN 冻结 device_type 否 String 设备类型：枚举类型，多个查询使用英文逗号分隔 枚举值： IPC 直连摄像机 NVR NVR设备 MEdge IVS1800设备 ability 否 Array of strings 查询的能力集列表：不传默认查询所有能力集，数组长度范围[0,10]。能力集对应能力参考设备能力集。 need_cloud_ability 否 Boolean 是否需要返回云上管理的能力集：false，不返回云上能力集信息；true，返回云上能力集信息。不填默认false need_specification 否 Boolean 是否需要能力规格：false，不返回能力规格；true，返回能力规格。不填默认false direction 否 String 排序方向：枚举类型，默认降序，不区分大小写 枚举值： ASC 升序 DESC 降序 limit 否 Integer 限制条数：取值范围[0,1000]，不填写时默认值为10 offset 否 Integer 偏移量页数：0为第一页，取值范围[0,2147483646]，不填写时默认为0，同时offset*limit需小于2147483646 sort_by 否 String 排序字段：枚举类型，默认按创建时间create_time排序 枚举值： create_time 创建时间 update_time 更新时间

响应示例 状态码： 200 OK { "device_id": "952352LWXT***", "device_name": "测试设备", "device_state": "ONLINE", "access_protocol": "HOLO", "device_type": "IPC", "device_system_state": "NORMAL", "description": "test", "model": "JVS-N71-HD", "manufacture": "JOVISION", "channel_total": 10, "stream_total": 2, "firmware": "V1.0", "device_ability" : "ptz,talk", "device_cloud_ability": { "alarm_voice": { "support": "true" }}, "create_time": "2020-06-26 20:42:16", "update_time": "2020-06-26 20:42:16", "protocol_version": "2.0.0", "mac": "xxx", "device_ip": "xxx.xxx.xxx.xxx", "device_port": "8090", "device_org_id": "1234567890***", "device_org_name": "测试组织***", "operator_total": "2", "sdk_ability": "***", "sn": "952352LWXT***" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 Query参数 参数 是否必选 参数类型 描述 ability 否 Array of strings 查询的能力集列表：不传默认查询所有能力集，数组长度范围[0,10]。能力集对应能力参考设备能力集。 need_cloud_ability 否 Boolean 是否需要返回云上管理的能力集：false，不返回云上能力集信息；true，返回云上能力集信息。不填默认false need_specification 否 Boolean 是否需要能力规格：false，不返回能力规格；true，返回能力规格。不填默认false

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 mac String 设备mac地址 device_id String 设备ID，设备唯一标识符，如：2102412969WLMB002258 device_name String 设备名称 device_state String 设备状态 枚举值： OFFLINE 离线 ONLINE 在线 UNREGISTERED 未注册 access_protocol String 接入类型 枚举值： GB28181 国标 HOLO 好望 device_type String 设备类型 枚举值： IPC 通用相机 NVR NVR设备 MEdge IVS1800设备 IPC-BULLET 枪机 IPC-BOX 筒机 IPC-CONCH 半球/海螺 IPDOME 球机 device_system_state String 设备系统冻结 枚举值： NORMAL 正常 UNAVAILABLE_FROZEN 冻结 description String 设备描述 model String 设备型号，如：D2150 manufacture String 生产厂商，如：HUAWEI channel_total Integer 通道总数 stream_total Integer 每个通道码流数量 firmware String 摄像头固件版本号 device_ability String 设备能力集：枚举类型，参考附录设备能力集，多个能力集用逗号分隔 device_cloud_ability Object 云端能力集规格 create_time String 创建时间 update_time String 更新时间，在设备重新上线后或者移动设备分组后会修改时间 protocol_version String 设备与平台接入协议版本，如：2.0.0 device_ip String 设备IP device_port String 设备端口 device_org_id String 设备组织ID sn String SN号，等于device_id——设备ID，设备唯一标识符 device_org_name String 设备所处的设备组织名称 operator_total String 操作员总数 sdk_ability String sdk能力集

URI GET /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章节

URI GET /v1/{user_id}/device-orgs/tree 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节 表2 Query参数 参数 是否必选 参数类型 描述 device_org_name 是 String 设备组织名称：支持数字、中文（一个汉字算两个字符）、英文、空格、-、_，长度范围[1,50]

响应示例 状态码： 200 OK { "result" : [ { "enterprise_id" : "1230488562***", "device_org_id" : "1357924680***", "device_org_name" : "研发", "parent_id" : "1234567890***", "device_org_level" : 2, "is_leaf" : 0, "is_result" : 1, "camera_count" : 0, "camera_online_count" : 0, "children" : [ { "children" : [ ], "enterprise_id" : "1230488562***", "device_org_id" : "1357924680***", "device_org_name" : "Name", "parent_id" : "1234567890***", "device_org_level" : 2, "is_leaf" : 1, "is_result" : 1, "camera_count" : 0, "camera_online_count" : 0 } ] } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result Array of QueryDeviceOrgTreeVo objects 响应信息 表5 QueryDeviceOrgTreeVo 参数 参数类型 描述 enterprise_id String 企业ID，企业唯一标识符 device_org_id String 设备组织ID device_org_name String 设备组织名称 parent_id String 上级设备组织ID device_org_level Integer 设备组织级别，第一级子节点数值为1，第二级为2，以此类推 is_leaf Integer 是否是叶子节点：枚举类型 枚举值： 1 叶子节点，没有子级设备组织 0 非叶子节点，有子级设备组织 is_result Integer 是否是查询结果 camera_count Integer 设备数量 camera_online_count Integer 在线设备数量 children Array of query_device_org_tree_children objects 子组织信息 表6 query_device_org_tree_children 参数 参数类型 描述 device_org_id String 设备组织ID device_org_level Integer 设备组织级别，第一级子节点数值为1，第二级为2，以此类推 device_org_name String 设备组织名称 enterprise_id Integer 企业ID，企业唯一标识 is_leaf Integer 是否是叶子节点：枚举类型 枚举值： 1 叶子节点，下没有子级设备组织 0 非叶子节点，下有子级设备组织 is_result Integer 是否是查询结果 parent_id String 上级设备组织ID camera_count Integer 设备数量 camera_online_count Integer 在线设备数量 children Array of query_device_org_tree_children objects 子组织信息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 device_ids 是 Array of strings 要移动设备ID集合：数组长度范围[1,100] 单个设备： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型

响应示例 状态码： 200 OK { "failed_num" : 1, "results" : [ { "device_id" : "952352DJNR***", "result" : { "code" : "IVM.0", "msg" : "Success" } }, { "device_id" : "952352LWXT***", "result" : { "code" : "IVM.10022037", "msg" : "Move device is not exist" } } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 failed_num Integer 移动失败设备数 results Array of northMoveDevicesResult objects 设备移动结果详细信息 表5 northMoveDevicesResult 参数 参数类型 描述 device_id String 设备ID，设备唯一标识符 result ResultInfo object 错误或正确信息 表6 ResultInfo 参数 参数类型 描述 code String 单个结果码 msg String 单个结果信息

URI POST /v1/{user_id}/device-orgs/{device_org_id}/move-devices 表1 路径参数 参数 是否必选 参数类型 描述 device_org_id 是 String 设备分组ID：由数字组成，长度范围[1,25]，可以从查询子级设备组织获取，根节点下不允许添加设备 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节

URI DELETE /v1/{user_id}/device-orgs/{device_org_id} 表1 路径参数 参数 是否必选 参数类型 描述 device_org_id 是 String 设备组织ID：由数字组成，长度范围[1,25]，可以从查询子级设备组织获取，根节点不允许删除 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 device_org_name 是 String 设备组织名称：支持数字、中文（一个汉字算两个字符）、英文、空格、-、_，长度范围[1,50] parent_org_id 是 String 父级组织ID：由数字组成，长度范围[1,25]，可以从查询子级设备组织获取，根节点无法添加子级组织

URI PUT /v1/{user_id}/device-orgs/{device_org_id} 表1 路径参数 参数 是否必选 参数类型 描述 device_org_id 是 String 设备组织ID：由数字组成，长度范围[1,25]，可以从查询子级设备组织中获取，根节点无法编辑 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 device_org_name 是 String 设备组织名称：支持数字、中文（一个汉字算两个字符）、英文、空格、-、_，长度范围[1,50]。可以从查询子级设备组织、查询企业下组织的设备列表中获得