Get Device Group List

Last Updated on : 2023-06-15 05:04:12

Get a list of device groups on pages.

API address

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

Request parameter

Parameter name	Type	IN	Required	Description
req	GroupPackageQueryReq	query	false	The input parameters.

Description of req

Parameter name	Type	Required	Description
group_name	String	false	The name of a specified group.
asset_id	String	false	The ID of a specified asset.
asset_ids	String	false	The asset IDs.
page_no	Integer	false	The page number.
page_size	Integer	false	The number of items returned on each page.

Return parameter

Parameter name	Type	Description
result	BasePageVO	The returned result.

Description of result

Parameter name	Type	Description
has_more	Boolean	Specifies whether to return the next page.
total	Long	The total number of groups.
list	List	The list of groups.

Description of list

Parameter name	Type	Description
group_id	String	The ID of a specified group.
group_name	String	The name of a specified group.
create_time	Long	The time when it is created.
update_time	Long	The time when it is updated.
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.
asset_id	String	The ID of a specified asset.

Request example

GET: /v1.0/iot-03/device-groups?pageNo=1&pageSize=2

Return example

{
    "result": {
        "list": [
            {
                "create_time": 1623208592,
                "group_name": "test_group1111",
                "update_time": 1623324050,
                "group_id": "14024642592****"
            },
            {
                "create_time": 1623223232,
                "group_name": "group_test",
                "update_time": 1623223232,
                "group_id": "14025071296****"
            },
            {
                "create_time": 1623208448,
                "group_name": "group_test",
                "update_time": 1623208448,
                "group_id": "140246945728****"
            },
            {
                "create_time": 1623153892,
                "group_name": "group_test",
                "update_time": 1623153892,
                "group_id": "140223887040****"
            },
            {
                "create_time": 1623152145,
                "group_name": "group_test",
                "update_time": 1623152145,
                "group_id": "140228183552****"
            }
        ],
        "total": 14,
        "has_more": true
    },
    "t": 1623827448052,
    "success": true
}

Error code

For more information, see error code.

Prev DocDelete Device Group

Next DocUpdate Device Group