V2.5 Search Device Group by Device


通过设备查询设备组信息。

请求格式

POST https://{apigw-address}/connect-service/v2.5/deviceGroups?action=searchDeviceGroupByDevice

请求参数(URI)

名称 位置(Path/Query) 必需/可选 数据类型 描述
orgId Query 必需 String 资产所属的组织 ID。 如何获取 orgId 信息>>

请求参数(Body)

名称 必需/可选 数据类型 描述
expression 可选 String 参见 如何使用查询表达式>>
deviceIdentifier 必需 结构体 参见 DeviceIdentifier 结构体

DeviceIdentifier 结构体


名称 数据类型 描述
assetId String 资产 ID。 如何获取Asset ID信息>>
productKey String Product Key。
deviceKey String Device Key。

响应参数

名称 数据类型 描述
code number 更新成功或失败的指示码。
msg String 成功时返回 OK;其他值则为失败。
requestId String 每次请求获取的 ID,用于唯一标识一次 API 请求。
data 结构体 参见 Data 结构体

Data 结构体


名称 数据类型 描述
groupId String 设备组ID
orgId String 资产所属组织ID
name StringI18n 设备组名称,结构参见 国际化名称结构体
desc String 设备组描述。
type String 设备组类型:STATIC、DYNAMIC。
condition String 动态设备组条件
createTime Number 创建时间。
updateTime Number 更新时间。

示例

请求示例


url: https://{apigw-address}/connect-service/v2.5/deviceGroups?action=searchDeviceGroupByDevice&orgId=yourOrgId
method: POST

返回示例


{
    "code": 0,
    "msg": "OK",
    "requestId": "626996dd-54cb-4dbe-8ac2-bcb4c2622971",
    "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": 1718950124873
    }]
}