设备分组
更新时间: 2023-04-19
# 分组列表
# 基本信息
Path： /v1/groups/:instanceId
Method： GET
接口描述：
# 请求参数
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| instanceId |
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| pageNo | 否 | ||
| pageSize | 否 | ||
| superGroupId | 否 | 不支持模糊匹配 | |
| rootGroupId | 否 | rootGroupId和superGroupId同时存在为子分组查询，rootGroupId不存在为根分组查询 | |
| keyword | 否 | 分组名称/分组id 模糊查询所有根、子节点，包含关键字时返回根分组 |
# 返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| pageNo | number | 必须 | |||
| result | object [] | 必须 | item 类型: object | ||
| ├─ groupName | string | 必须 | |||
| ├─ groupDesc | string | 必须 | 枚举: 描述1,测试描述2 | ||
| ├─ superGroupId | string | 必须 | |||
| ├─ rootGroupId | string | 必须 | |||
| ├─ updateTime | string | 必须 | |||
| ├─ createTime | string | 必须 | |||
| ├─ groupId | string | 必须 | |||
| ├─ hasChildren | boolean | 必须 | true： 存在子节点 false： 不存在子节点 | ||
| pageSize | number | 必须 | |||
| totalCount | number | 必须 | |||
| groupName | string | 必须 | |||
| superGroupId | string | 必须 |
# 新增分组
# 基本信息
Path： /v1/groups/:instanceId
Method： POST
接口描述：
# 请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| instanceId |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| groupName | string | 必须 | 2~30字符，可为汉字、大小写英文、数字、下划线。 ^[\u4e00-\u9fa5a-zA-Z0-9_]{2,30}$ | ||
| superGroupId | string | 非必须 | 父分组 | ||
| groupDesc | string | 非必须 | 0~255字符。 ^[\s\S]{0,255}$ |
# 返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| groupId | string | 必须 | |||
| groupName | string | 必须 | |||
| superGroupId | string | 必须 | |||
| groupDesc | string | 必须 | |||
| rootGroupId | string | 必须 | |||
| depth | string | 必须 | 层级 | ||
| createTime | string | 必须 | |||
| updateTime | string | 必须 |
# 删除分组
# 基本信息
Path： /v1/groups/:instanceId/:groupId
Method： DELETE
接口描述：
# 请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| instanceId | ||
| groupId |
Body
无
# 返回数据
无
# 修改分组
# 基本信息
Path： /v1/groups/:instanceId/:groupId
Method： PUT
接口描述： 返回修改后的分组详细
# 请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| instanceId | ||
| groupId |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| groupName | string | 非必须 | 2~30字符，可为汉字、大小写英文、数字、下划线。 | ||
| groupDesc | string | 非必须 | 0~255字符。 | ||
| targetGroupId | string | 非必须 |
# 返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| groupId | string | 必须 | |||
| groupName | string | 必须 | |||
| groupDesc | string | 必须 | |||
| superGroupId | string | 必须 | |||
| rootGroupId | string | 必须 | |||
| updateTime | string | 必须 | |||
| createTime | string | 必须 |
# 分组信息
# 基本信息
Path： /v1/groups/:instanceId/:groupId
Method： GET
接口描述：
# 请求参数
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| instanceId | ||
| groupId |
# 返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| groupId | string | 必须 | |||
| groupName | string | 必须 | |||
| groupDesc | string | 必须 | |||
| superGroudId | string | 必须 | |||
| rootGroupId | string | 必须 | |||
| updateTime | string | 必须 | |||
| createTime | string | 必须 | |||
| hasChildren | boolean | 必须 |
# 添加设备到分组
# 基本信息
Path： /v1/groups/:instanceId/:groupId/devices
Method： POST
接口描述：
# 请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| instanceId | ||
| groupId |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| object [] | 非必须 | item 类型: object | |||
| ├─ productKey | string | 必须 | |||
| ├─ deviceName | string | 必须 |
# 返回数据
无
# 分组中删除设备
# 基本信息
Path： /v1/groups/:instanceId/:groupId/devices/delete
Method： PUT
接口描述：
# 请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| instanceId | ||
| groupId |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| object [] | 非必须 | item 类型: object | |||
| ├─ productKey | string | 必须 | |||
| ├─ deviceName | string | 必须 |
# 返回数据
无