Query Group Devices

Last Updated on : 2023-11-23 03:42:39download

Query devices in the specified group based on the group ID.

API address

GET: /v2.0/cloud/thing/group/{group_id}/devices

Request parameter

Parameter nameTypeINRequiredDescription
group_idLongpathtrueThe ID of the specified group.
page_sizeIntegerquerytrueThe number of entries to be returned per page.
page_noIntegerquerytrueThe current page number.

Return parameter

Parameter nameTypeDescription
resultJSONThe list of returned data.
successBooleanIndicates whether the operation is successful. Valid values:
  • true: The operation succeeded.
  • false: The operation failed.
tLongThe timestamp.
tidStringThe link ID.

Description of result

Parameter nameTypeDescription
countIntegerThe total number of returned entries.
page_sizeIntegerThe number of entries to be returned per page.
page_numberIntegerThe current page number.
data_listListThe list of devices in the group.

Description of data_list

Parameter nameTypeDescription
group_idStringThe ID of the specified group.
dev_idStringThe device ID.
statusBooleanThe status of a device in the specified group. Valid values:
  • true: valid.
  • false: invalid.
display_orderIntegerThe sequence of devices.
gmt_createLongThe time when a device is created.
gmt_modifiedLongThe time when a device is modified.

Request example

GET: /v2.0/cloud/thing/group/12856***/devices
{
  "page_size": 1,
  "page_no": 1
}

Return example

{
    "tid": "798a754bb31f11edaa2fba12a1143bd9",
    "result": {
        "data_list": [
            {
                "gmt_create": 1677118001658,
                "display_order": 1,
                "gmt_modified": 1677118001658,
                "dev_id": "vdevo163815529**",
                "group_id": "12856***",
                "status": true
            }
        ],
        "count": 1,
        "page_number": 1,
        "page_size": 1
    },
    "t": 1677118328341,
    "success": true
}

Error code

For more information, see error code.

Limits on API Request Frequency

For more information, see Limits on API Request Frequency.