响应示例 返回状态码为200：查询认证设备组成功，响应体参考DevGroupQueryOutputApiDto。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "data" : [ { "id" : "2be5a878-b311-4e85-8ae2-560f5fddd966", "bsid" : "0000", "name" : "devgroup", "description" : "this is devgroup", "parentId" : "2be5a878-b311-4e85-8ae2-560f5fddd966", "fullName" : "ROOT/sub", "orderId" : 0, "hasPermission" : false, "childList" : [ { "id" : "2be5a878-b311-4e85-8ae2-560f5fddd966", "bsid" : "0000", "name" : "devgroup", "description" : "this is devgroup", "parentId" : "2be5a878-b311-4e85-8ae2-560f5fddd966", "fullName" : "ROOT/sub", "orderId" : 0, "hasPermission" : false, "childList" : [ { ... } ] } ] } ] }

响应参数 返回状态码为200：查询认证设备组成功，响应体参考DevGroupQueryOutputApiDto。 表2 DevGroupQueryOutputApiDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data ARRAY_REFERENCE 0-200个列表项，详细请参见表3。 返回数据内容。 - 表3 DevGroupApiObj对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string - - 设备组ID，UUID格式。 "2be5a878-b311-4e85-8ae2-560f5fddd966" bsid string 4~20个字符。 - 层级ID。 "0000" name string 1~64个字符。 - 名称。 "devgroup" description string 0~256个字符。 - 描述。 "this is devgroup" parentId string - - 父设备组ID，UUID格式。 "2be5a878-b311-4e85-8ae2-560f5fddd966" fullName string - - 设备组全名称。 "ROOT/sub" orderId int32 - - 同一层级顺序。 0 hasPermission boolean true false - 是否拥有操作权限，false没有，true有。默认值为false。 false childList ARRAY_REFERENCE 0-200个列表项，详细请参见表3。 子设备组 -

请求示例 HTTP的示例 GET /controller/campus/v1/accesscfg/devgroup/third/list?keyword=abc HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-AC CES S-TOKEN: x-yyyyyy

响应示例 状态码： 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 数量从大到小

请求参数 参数 必选/可选 类型 位置 描述 app_key 必选 String header 访问 物联网平台 的应用ID，在物联网平台创建应用时由平台分配获得。 Authorization 必选 String header 访问物联网平台的认证信息，值为“Bearer {accessToken}”，其中{accessToken}为调用鉴权接口返回的accessToken。 devGroupId 必选 String path 设备组ID，在增加设备组后由物联网平台返回获得。 accessAppId 可选 String query 设备组所属的应用ID，当删除授权应用下的设备组时才需要填写。

错误码 Http状态码 错误码 错误描述 说明 200 100203 The application is not existed. 应用不存在。 处理建议: 请检查HTTP请求头域中携带的appId是否有误。 请检查请求路径（url）中传入的appId是否有误。 200 100217 The application hasn't been authorized 应用未被授权。 处理建议：若非应用授权场景，请确认请求参数中的appId为空。 200 100603 The device group is not existed 设备组不存在。 处理建议：请检查设备组ID是否正确。 403 1010009 app throttle exceed. 应用调用接口过于频繁，超过流控值（默认值是100次/60s）。 处理建议：联系物联网平台维护人员调大流控阈值或者控制接口的调用频率。 403 1010005 Invalid access token or appId. 错误的token信息。 处理建议：请检查接口请求中所携带的accessToken是否有误。 500 50252 Internal server error. 服务器运行内部错误。 处理建议：物联网平台内部错误，请联系物联网平台维护人员处理。

响应示例 HTTP/1.1 200 OK Server: product only Date: Tue, 19 Nov 2019 21:47:16 GMT Content-Type: application/yang.data+json Content-Length: 77 Connection: keep-alive Keep-Alive: timeout=60 X-Frame-Options: DENY Strict-Transport-Security: max-age=31536000;incodeSubDomains Cache-Control: no-cache, no-store, must-revalidate X-Content-Type-Options: nosniff Pragma: no-cache Expires: Thu, 01 Jan 1970 00:00:00 GMT X-XSS-Protection: 1; mode=block {"device-shell-group-northbound:device-group":[{"device-group-name":"cccc"}]}

响应参数 返回状态码为200：查询成功 表2 body对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 device-shell-group-northbound:device-group list 详细信息请参见表 device-shell-group-northbound:device-group对象的参数列表 - 表3 device-shell-group-northbound:device-group对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 device-group-name string 1-128个字符 - - device-child-group-names list 详细信息请参见表 device-child-group-names对象的参数列表 如果设备组不存在子设备则不显示。 device-ids list 详细信息请参见表 device-ids对象的参数列表 如果设备组不存在设备则不显示。 表4 device-child-group-names对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 device-child-group-name string 1-128个字符 - 子设备组名，包括数字，字母，特殊字符-_@的一种或组合，且不能以数字开头。 表5 device-ids对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 device-id string 1-128个字符 - 设备ID。 返回状态码为40X：参数不正确。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。 表6 错误码描述 Status Code Error Code Error Message Parameter 错误说明 400 0x006e004b 解析请求体发生错误。 错误的参数字段。 请求体body存在错误。 409 0x00c80014 设备组{0}不存在。 {0}：设备组名。 查询的设备组不存在。 500 0x00c80006 操作数据库异常。 - 系统内部错误，操作数据库存在异常。

请求示例 cURL示例 curl -k -s -L -i -X GET \ https://{ip:port}/restconf/data/device-shell-group-northbound:device-shell-group/device-group/cccc \ -H 'cache-control: no-cache' \ -H 'content-type: application/json' \ -H 'x-access-token: x-ntc9c745ryk9uohj7vpint3wsanwo9nvnuur4bg5ir08bt3woavsjvc46rurrx9djzfy84k8c988qqnw04ldjw5hlfuq6q5iqpsbqkvwc82rvx0bvxnsgbhg5doa7wg9' HTTP示例 GET /restconf/data/device-shell-group-northbound:device-shell-group/device-group/cccc HTTP/1.1 Host: {ip:port} Content-Type: application/json x-access-token: x-ntc9c745ryk9uohj7vpint3wsanwo9nvnuur4bg5ir08bt3woavsjvc46rurrx9djzfy84k8c988qqnw04ldjw5hlfuq6q5iqpsbqkvwc82rvx0bvxnsgbhg5doa7wg9 Cache-Control: no-cache

响应示例 HTTP/1.1 204 No Content Server: product only Date: Tue, 19 Nov 2019 21:49:46 GMT Connection: keep-alive Keep-Alive: timeout=60 X-Frame-Options: DENY Strict-Transport-Security: max-age=31536000;incodeSubDomains Cache-Control: no-cache, no-store, must-revalidate X-Content-Type-Options: nosniff Pragma: no-cache Expires: Thu, 01 Jan 1970 00:00:00 GMT X-XSS-Protection: 1; mode=block

请求参数 表1 url参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 device-group-name 是 string 1-128个字符 - 环境中存在的一个设备组名，包括数字，字母，特殊字符-_@的一种或组合，且不能以数字开头。 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 device-group-name 是 string 1-128个字符 必须与表 url参数列表中参数device-group-name一致，包括数字，字母，特殊字符-_@的一种或组合，且不能以数字开头。 device-ids 是 list 详细信息请参见表 device-ids对象的参数列表 - 表3 device-ids对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 device-id 是 string 1-128个字符 - 设备ID。

请求示例 cURL示例 curl -k -s -L -i -X PUT \ https://{ip:port}/restconf/data/device-shell-group-northbound:device-shell-group/device-group/cccc \ -H 'cache-control: no-cache' \ -H 'content-type: application/json' \ -H 'x-access-token: x-ntc9c745ryk9uohj7vpint3wsanwo9nvnuur4bg5ir08bt3woavsjvc46rurrx9djzfy84k8c988qqnw04ldjw5hlfuq6q5iqpsbqkvwc82rvx0bvxnsgbhg5doa7wg9' \ -d '{ "device-group": { "device-group-name": "cccc", "device-ids": [{ "device-id": "8d394835-cb84-38f3-a4d5-16a7f2074b40" }] } }' HTTP示例 PUT /restconf/data/device-shell-group-northbound:device-shell-group/device-group/cccc HTTP/1.1 Host: {ip:port} Content-Type: application/json x-access-token: x-ntc9c745ryk9uohj7vpint3wsanwo9nvnuur4bg5ir08bt3woavsjvc46rurrx9djzfy84k8c988qqnw04ldjw5hlfuq6q5iqpsbqkvwc82rvx0bvxnsgbhg5doa7wg9 Cache-Control: no-cache body: { "device-group": { "device-group-name": "cccc", "device-ids": [{ "device-id": "8d394835-cb84-38f3-a4d5-16a7f2074b40" }] } }

响应参数 返回状态码为204：新增成功。 返回状态码为40X：参数不正确。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。 表4 错误码描述 Status Code Error Code Error Message Parameter 错误说明 400 0x006e004b 解析请求体发生错误。 错误的参数字段。 请求体body存在错误。 500 0x00c80014 数据不存在。 - 增加的设备不存在。 500 0x00c80006 操作数据库异常。 - 系统内部错误，操作数据库存在异常。