查询所有设备分组
功能介绍
查询所有设备分组
URI
GET /v2/{project_id}/link/instances/{instance_id}/device-groups
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。 最小长度：0 最大长度：32 |
| instance_id | 是 | String | 实例ID 最小长度：0 最大长度：36 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| app_id | 是 | String | 应用ID 最小长度：0 最大长度：36 |
请求参数
无
响应参数
状态码： 200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 总数 最小值：1 最大值：99999999 |
| size | Integer | 本次返回数量 最小值：1 最大值：9999 |
| items | Array of GroupTreeResponse objects | 设备分组信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | Integer | 分组id 最小值：1 最大值：99999999 |
| name | String | 分组名称 最小长度：0 最大长度：200 |
| parent_id | Integer | 父分组id 最小值：1 最大值：99999999 |
| children | Array of GroupTreeResponse objects | 子分组 |
| app_id | String | 应用id 最小长度：0 最大长度：200 |
| permissions | Array of strings | 权限 |
状态码： 400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码 最小长度：0 最大长度：64 |
| error_msg | String | 错误描述 最小长度：0 最大长度：200 |
| request_id | String | 消息ID 最小长度：0 最大长度：64 |
状态码： 404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码 最小长度：0 最大长度：64 |
| error_msg | String | 错误描述 最小长度：0 最大长度：200 |
| request_id | String | 消息ID 最小长度：0 最大长度：64 |
状态码： 500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码 最小长度：0 最大长度：64 |
| error_msg | String | 错误描述 最小长度：0 最大长度：200 |
| request_id | String | 消息ID 最小长度：0 最大长度：64 |
请求示例
GET /{project_id}/link/instances/{instance_id}/device-groups 响应示例
状态码： 200
OK
{
"total" : 1,
"size" : 1,
"items" : [ {
"permissions" : [ "read", "access", "delete", "modify" ],
"id" : 14,
"name" : "group_name",
"parent_id" : 0,
"children" : [ ],
"app_id" : "fe382523-cf76-4152-9fc6-f772d4427302"
} ]
} 状态码： 400
Bad Request
{
"error_code" : "SCB.00000000",
"error_msg" : "Parameter is not valid for operation [romalink.link-device-groups.selectGroupNodeTree]. Parameter is [app_id]. Processor is [query].",
"requestId" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01"
} 状态码： 404
Not Found
{
"error_code" : "SCB.00000000",
"error_msg" : "Not Found"
} 状态码： 500
Internal Server Error
{
"error_code" : "ROMA.00110002",
"error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611",
"request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 404 | Not Found |
| 500 | Internal Server Error |
错误码
请参见错误码。
