更新时间:2024-05-21 GMT+08:00
分享

查询子级设备组织

功能介绍

获取子级设备组织,可以从根组织节点开始往下一级查询

URI

GET /v1/{user_id}/device-orgs/{device_org_id}/sub-orgs

表1 路径参数

参数

是否必选

参数类型

描述

device_org_id

String

设备组织ID:由数字组成,长度范围[1,25](根组织节点的值为0,从此接口逐级往下获取子组织节点)

user_id

String

用户ID:由数字组成,长度范围[15,25],获取方式参考获取user ID与下载AK/SK章节

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Access-Token

String

用户认证AccessToken:从获取用户北向接口认证AccessToken中获取

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

orgs

Array of getChildOrgResp_org_list objects

响应信息

表4 getChildOrgResp_org_list

参数

参数类型

描述

device_org_id

String

设备组织ID

device_org_name

String

设备组织名称

device_org_level

Integer

设备组织级别,第一级子节点数值为1,第二级为2,以此类推

camera_count

Integer

该设备组织下的(包括子级组织)设备个数

camera_online_count

Integer

该设备组织下的(包括子级组织)设备在线数量

is_leaf

Integer

是否是叶子节点:枚举类型

枚举值:

  • 1 叶子节点,没有子级设备组织
  • 0 非叶子节点,有子级设备组织

channel_count

Integer

该设备组织下的(包括子级组织)通道在线数量

channel_online_count

Integer

该设备组织下的(包括子级组织)通道在线总数

channel_offline_count

Integer

该设备组织下的(包括子级组织)通道离线总数

请求示例

查询子级设备组织

GET /v1/2562572829***/device-orgs/1234567890***/sub-orgs

响应示例

状态码: 200

OK

{
  "orgs" : [ {
    "device_org_id" : "1234567890***",
    "device_org_name" : "3级分组",
    "device_org_level" : 3,
    "camera_count" : 10,
    "camera_online_count" : 5,
    "is_leaf" : 0,
    "channel_count" : 200,
    "channel_online_count" : 50,
    "channel_offline_count" : 150
  } ]
}

状态码

请参见状态码

错误码

请参见错误码

相关文档