V2.5 Search Device Group by Device¶

Search device group by devices.

Request Format¶

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

Request Parameters (URI)¶

Name	Location (Path/Query)	Mandatory/Optional	Data Type	Description
orgId	Query	Mandatory	String	The organization ID which the asset belongs to. How to get orgId>>

Request Parameters (Body)¶

Name	Mandatory/Optional	Data Type	Description
expression	Optional	String	For more details, see How to use expression>>
deviceIdentifier	Mandatory	Struct	See DeviceIdentifier Struct.

DeviceIdentifier Struct ¶

Name	Data Type	Description
assetId	String	The asset ID. How to get assetId>>
productKey	String	Product Key.
deviceKey	String	Device Key.

Response Parameters¶

Name	Data Type	Description
code	number	Failed or succeeded to create an alert. 0: succeeded, -1: failed.
msg	String	Returns `OK` if successful. Other returned values indicate failure.
requestId	String	A unique ID to identify a request.
data	Struct	See Data Struct.

Data Struct ¶

Name	Data Type	Description
groupId	String	Device group ID
orgId	String	Organization ID.
name	StringI18n	Device group name. For more details on the structure and locales supported, see Internationalized name struct.
desc	String	Device group description.
type	String	Device group type: STATIC, DYNAMIC.
condition	String	Conditions of the dynamic device group
createTime	Number	Create time.
updateTime	Number	Update time.

Samples¶

Request Sample¶

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

Return Sample¶

{
    "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
    }]
}