云服务器内容精选

  • 响应示例 状态码: 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 } ] }
  • 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章节
  • 响应参数 状态码: 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 该设备组织下的(包括子级组织)通道离线总数
  • 错误码 Http状态码 错误码 错误描述 说明 200 100203 The application is not existed. 应用不存在。 处理建议: 请检查HTTP请求头域中携带的appId是否有误。 请检查请求路径(url)中传入的appId是否有误。 200 100217 The application hasn't been authorized. 应用未被授权。 处理建议:若非应用授权场景,请确认请求参数中的appId为空。 200 100601 The number of device in the group has reach the max. 设备组内设备达到最大值。 处理建议:请确认当前设备组内的设备数量在maxDevNum设置值的范围内。 200 100602 The device group name has been used. 设备组的名字已经存在。 处理建议:请修改接口请求中的设备组名称。 200 100603 The device group is not existed. 设备组不存在。 处理建议:请检查设备组ID是否正确。 400 50400 The input is invalid. 输入参数无效。 处理建议:请检查接口调用请求中携带参数的合法性。 403 1010009 app throttle exceed. 应用调用接口过于频繁,超过流控值(默认值是100次/60s)。 处理建议:联系 物联网平台 维护人员调大流控阈值或者控制接口的调用频率。 403 1010005 Invalid access token or appId. 错误的token信息。 处理建议:请检查接口请求中所携带的accessToken是否有误。 500 50252 Internal server error. 服务器运行内部错误。 处理建议:物联网平台内部错误,请联系物联网平台维护人员处理。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明:用户Token。通过调用 IAM 服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明:实例ID。物理多租下各实例的唯一标识,建议携带该参数,在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID,具体获取方式请参考查看实例详情 。
  • URI GET /v5/iot/{project_id}/device-group/{group_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明:项目ID。获取方法请参见 获取项目ID 。 group_id 是 String 参数说明:设备组ID,用于唯一标识一个设备组,在创建设备组时由物联网平台分配。 取值范围:长度不超过36,十六进制字符串和连接符(-)的组合。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 group_id String 设备组ID,用于唯一标识一个设备组,在创建设备组时由物联网平台分配。 name String 设备组名称,单个资源空间下不可重复。 description String 设备组描述。 super_group_id String 父设备组ID,该设备组的父设备组ID。 group_type String 设备组类型,分为动态设备组和静态设备组两种 dynamic_group_rule String 动态设备组规则
  • 响应示例 状态码: 200 OK { "group_id" : "04ed32dc1b0025b52fe3c01a27c2babc", "name" : "GroupA", "description" : "群组A", "super_group_id" : "04ed32dc1b0025b52fe3c01a27c2b0a8", "group_type" : "STATIC" }
  • URI DELETE /v5/iot/{project_id}/device-group/{group_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明:项目ID。获取方法请参见 获取项目ID 。 group_id 是 String 参数说明:设备组ID,用于唯一标识一个设备组,在创建设备组时由物联网平台分配。 取值范围:长度不超过36,十六进制字符串和连接符(-)的组合。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明:实例ID。物理多租下各实例的唯一标识,建议携带该参数,在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID,具体获取方式请参考查看实例详情 。
  • 响应示例 状态码: 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 子组织信息
  • 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]
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken:从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 device_org_name 是 String 设备组织名称:支持数字、中文(一个汉字算两个字符)、英文、空格、-、_,长度范围[1,50] parent_org_id 是 String 父级组织ID:由数字组成,长度范围[1,25],可以从查询子级设备组织获取,根节点无法添加子级组织
  • 错误码 Http状态码 错误码 错误描述 说明 200 100601 The number of device in the group has reach the max. 设备组内设备达到最大值。 处理建议:请确认当前设备组内的设备数量在maxDevNum设置值的范围内。 200 100603 The device group is not existed. 设备组不存在。 处理建议:请检查设备组ID是否正确。 400 100604 The device group request parameter is invalid. 请求参数不合法。 处理建议: 请检查接口请求中的设备ID是否有误。 请检查设备组是否达到最大设备数量限制。 400 50400 The input is invalid. 输入参数无效。 处理建议:请检查接口调用请求中携带参数的合法性。 403 100203 The application is not existed. 应用不存在。 处理建议: 请检查HTTP请求头域中携带的appId是否有误。 请检查请求路径(url)中传入的appId是否有误。 403 100217 The application hasn't been authorized. 应用未被授权。 处理建议:若非应用授权场景,请确认请求参数中的appId为空。 403 1010009 app throttle exceed. 应用调用接口过于频繁,超过流控值(默认值是100次/60s)。 处理建议:联系物联网平台维护人员调大流控阈值或者控制接口的调用频率。 403 1010005 Invalid access token or appId. 错误的Token信息。 处理建议:请检查接口请求中所携带的accessToken是否有误。 500 100203 The application is not existed. 应用不存在。 处理建议: 请检查HTTP请求头域中携带的appId是否有误。 请检查请求路径(url)中传入的appId是否有误。 500 50252 Internal server error. 服务器运行内部错误。 处理建议:物联网平台内部错误,请联系物联网平台维护人员处理。