V2.5 Get Device Group¶
获取设备组信息。
操作权限¶
需授权的服务 |
所需操作权限 |
---|---|
设备管理 |
Read |
请求格式¶
GET https://{apigw-address}/connect-service/v2.5/deviceGroups?action=getGroup
请求参数(URI)¶
名称 |
位置(Path/Query) |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|---|
orgId |
Query |
必需 |
String |
资产所属的组织 ID。如何获取 orgId 信息>> |
groupId |
Query |
必需 |
String |
设备组 ID。在 EnOS 管理控制台中前往 设备管理 > 设备组 获取设备组ID。 |
响应参数¶
名称 |
数据类型 |
描述 |
---|---|---|
code |
Number |
响应码 |
msg |
String |
对状态码的解释和说明。请求成功为 “OK”。 |
requestId |
String |
每次请求获取的ID,用于唯一标识一次API请求。 |
data |
Device 结构体数组 |
有关 Device 结构体的定义,其结构参见 Device 结构体。 |
Device 结构体 ¶
名称 |
数据类型 |
描述 |
---|---|---|
groupId |
String |
设备组ID。在 EnOS 管理控制台中前往 设备管理 > 设备组 获取设备组ID。 |
orgId |
String |
资产所属组织ID |
name |
StringI18n |
设备组名称,结构参见 国际化名称结构体。 |
desc |
String |
设备组描述。 |
type |
String |
设备组类型:STATIC、DYNAMIC。 |
condition |
String |
动态设备组条件。更多信息,参见 [动态规则](/docs/device-connection/zh_CN/preview/howto/device/managing_device_group.html#rule)。 |
createTime |
Number |
创建时间。 |
updateTime |
Number |
更新时间。 |
示例¶
请求示例¶
url: https://{apigw-address}/connect-service/v2.5/deviceGroups?action=getGroup&orgId=yourOrgId&groupId=yourGroupId
method: GET
返回示例¶
{
"code": 0,
"msg": "OK",
"requestId": "39d882e7-8cf9-4f6e-863f-dd65bb2af7a4",
"data": {
"groupId": "yourGroupId",
"orgId": "yourOrgId",
"name": {
"defaultValue": "GroupName_test",
"i18nValue": {
"en_US": "name",
"zh_CN": "中文名",
"es_ES": "nombre",
"ja_JP": "名前"
}
},
"desc": "GroupDescription",
"type": "STATIC",
"condition": null,
"status": "ACTIVE",
"createTime": 1718950104553,
"updateTime": 1718950124698
}
}