Appearance
设备分组管理
设备分组用于管理和组织设备,支持创建、查询、更新和删除操作。
获取设备组列表
获取当前组织的所有设备组。
请求
http
GET /api/v2/device-groups/
参数
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
page | integer | 否 | 页码,默认为1 |
page_size | integer | 否 | 每页数量,默认为20 |
响应
json
{
"success": true,
"data": [
{
"pk": 0,
"name": "设备组名称",
"device_count": 10
}
],
"error": null
}
创建设备组
创建新的设备组。
请求
http
POST /api/v2/device-groups/
请求参数
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
name | string | 是 | 设备组名称 |
weight | integer | 否 | 权重,用于排序 |
请求示例
json
{
"name": "设备组名称"
}
响应
json
{
"success": true,
"data": {
"pk": 0,
"name": "设备组名称",
"device_count": 0
},
"error": null
}
更新设备组
更新现有设备组的信息。
请求
http
PUT /api/v2/device-groups/{group_id}/
请求参数
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
name | string | 是 | 设备组名称 |
请求示例
json
{
"name": "设备组名称"
}
响应
json
{
"success": true,
"data": {
"pk": 0,
"name": "设备组名称",
"device_count": 10
},
"error": null
}
部分更新设备组
部分更新设备组信息。
请求
http
PATCH /api/v2/device-groups/{group_id}/
请求参数
同更新设备组,但所有字段都是可选的。
请求示例
json
{
"name": "设备组名称",
"weight": 0
}
响应
json
{
"success": true,
"data": {
"id": "group_id",
"name": "设备组名称",
"description": "设备组描述",
"device_count": 10
},
"error": null
}
删除设备组
删除指定的设备组。
请求
http
DELETE /api/v2/device-groups/{group_id}/
响应
成功删除返回 204 状态码,无响应内容。
错误码
错误码 | 说明 |
---|---|
401 | 未认证 |
403 | 无权限或组织未激活 |
404 | 设备组不存在 |
400 | 请求参数错误 |