V2.5 Search Device Group¶
查询设备组信息
请求参数(URI)¶
名称 | 位置(Path/Query) | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|---|
orgId | Query | 必需 | String | 资产所属的组织ID。如何获取 orgId 信息>> |
请求参数(Body)¶
名称 | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|
expression | 可选 | String | 查询表达式,目前支持的字段有 groupId 、 groupName 、groupType 。字段之间支持逻辑运算符 and、or。如何使用查询表达式>> |
pagination | 可选 | Pagination 请求结构体 | 随机分页。如未指定,默认每页 10 条。每页最大记录数为 1,000 条,但为获得最佳性能,建议每页不超过 50 条。EnOS Edge 单页最大上限为 3,000 条。不支持使用 sorters 参数对结果进行排序。Pagination 请求结构体>> |
响应参数¶
名称 | 数据类型 | 描述 |
---|---|---|
code | number | 更新成功或失败的指示码。 |
msg | String | 成功时返回 OK ;其他值则为失败。 |
requestId | String | 每次请求获取的 ID,用于唯一标识一次 API 请求。 |
data | Data结构体。 | 参见 Device 结构体。 |
pagination | Pagination 请求结构体 | 参见 Pagination 请求结构体>> |
Device 结构体 ¶
名称 | 数据类型 | 描述 |
---|---|---|
groupId | String | 设备组ID |
orgId | String | 资产所属的组织 ID。如何获取 orgId 信息>> |
name | StringI18n | 设备组的名称。结构参见 国际化名称结构体。 |
desc | String | 设备组描述。 |
type | String | 设备组类型:STATIC、DYNAMIC。 |
condition | String | 动态设备组条件 |
createTime | number | 创建时间。 |
updateTime | number | 更新时间。 |
示例¶
请求示例¶
url: https://{apigw-address}/connect-service/v2.5/deviceGroups?action=searchGroup&orgId=yourOrgId
method: POST
requestBody:
{
"expression": "groupId in ('groupId')",
"pagination": {
"pageNo": 1,
"pageSize": 100
}
}
返回示例¶
{
"code": 0,
"msg": "OK",
"requestId": "901189f7-c31b-436f-beca-67c3dac92428",
"data": [
{
"groupId": "yourGroupId",
"orgId": "yourOrgId",
"name": {
"defaultValue": "GroupName",
"i18nValue": {
"en_US": "name",
"zh_CN": "中文名",
"es_ES": "nombre",
"ja_JP": "名前"
}
},
"desc": "groupDescription",
"type": "STATIC",
"condition": null,
"status": "READY",
"createTime": 1718950104553,
"updateTime": 1718950124698
}
],
"pagination": {
"sortedBy": null,
"pageNo": 1,
"pageSize": 100,
"totalSize": 1
}
}