Get Details of Device Group

Last Updated on : 2023-06-15 05:50:23

Based on the group ID, get the details of a specified device group, including the group name, the device IDs under the group, and the creation time of the group.

API address

GET: /v1.0/iot-03/device-groups/{group_id}

Request parameter

Parameter name	Type	IN	Required	Description
group_id	String	uri	true	The ID of a specified group.

Return parameter

Parameter name	Type	Description
result	GroupPackageDetailVO	The details of a specified device group.

Description of result

Parameter name	Type	Description
group_name	String	The name of a specified group.
device_ids	List	The list of device IDs in a specified group.
group_id	String	The ID of a specified group.
asset_id	String	The ID of a specified asset.
processing_status	Integer	The execution status of a specified task. Valid values: `0`: Devices are being added to the group or removed from the group. `1`: The adding/removal operation of all devices is successful. `2`: The adding/removal operation of some devices is successful. `3`: The adding/removal operation of all devices failed.

Request example

GET: /v1.0/iot-03/device-groups/145289715185510****

Return example

{
    "result": {
        "group_name": "F1 Light",
        "device_ids": [
            "vdevo16267452173****"
        ]
    },
    "t": 12321312213,
    "success": true
}

Error code

For more information, see error code.

Prev DocCreate Device Group

Next DocStore Management