Cloud Services API ReferenceIoT CoreDevice GroupQuery Group Devices

Query Group Devices

Last Updated on : 2023-11-23 06:26:05download

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 name	Type	IN	Required	Description
group_id	Long	path	true	The ID of the specified group.
page_size	Integer	query	true	The number of entries to be returned per page.
page_no	Integer	query	true	The current page number.

Return parameter

Parameter name	Type	Description
result	JSON	The list of returned data.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: The operation succeeded. `false`: The operation failed.
t	Long	The timestamp.
tid	String	The link ID.

Description of result

Parameter name	Type	Description
count	Integer	The total number of returned entries.
page_size	Integer	The number of entries to be returned per page.
page_number	Integer	The current page number.
data_list	List	The list of devices in the group.

Description of data_list

Parameter name	Type	Description
group_id	String	The ID of the specified group.
dev_id	String	The device ID.
status	Boolean	The status of a device in the specified group. Valid values: `true`: valid. `false`: invalid.
display_order	Integer	The sequence of devices.
gmt_create	Long	The time when a device is created.
gmt_modified	Long	The 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.

Prev DocSend Group Properties

Next DocScene Linkage Rules