Cloud Services API ReferenceIoT CoreDevice GroupGet Groups in Space

Get Groups in Space

Last Updated on : 2023-11-23 06:38:45download

Based on the space ID, get a list of groups in the specified space.

API address

GET: /v2.0/cloud/thing/group

Request parameter

Parameter name	Type	IN	Required	Description
space_id	String	query	true	The ID of the specified space.
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	SpaceDeviceGroupDTO	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
dataList	List	The list of data.
count	Integer	The total number of returned entries.
page_size	Integer	The number of entries to be returned per page.
pag_number	Integer	The current page number.

Description of dataList

Parameter name	Type	Description
id	Long	The ID of the specified group.
name	String	The name of the specified group.
pv	String	The protocol version number.
time	Long	The time when a group was created.
type	Integer	The grouping type.
uid	String	The ID of the specified user.
group_type	Integer	The type of the specified group.
icon_url	String	The picture of the specified group.
local_key	String	The `localKey` used for the MQTT connection.
owner_id	String	The ID of the specified space.
product_id	String	The product ID (PID).

Request example

GET: /v2.0/cloud/thing/group

{
  "space_id": "158170***",
  "page_no": 1,
  "page_size": 10
}

Return example

{
    "tid": "e36ef6c3b32111edaddddda1143bd9",
    "result": {
        "count": 11,
        "page_number": 1,
        "dataList": [
            {
                "icon_url": "https://images.tuyaus.com/smart/solution/15001/66ba22c327bfbf3d_co***.png",
                "standard": false,
                "dp_name": {
                    "1": "",
                    "9": ""
                },
                "local_key": "b74a3d9762a9f***",
                "dps": {
                    "1": false,
                    "9": 0
                },
                "owner_id": "25129***",
                "pv": "2.2",
                "device_num": 2,
                "group_type": 0,
                "type": 0,
                "dev_id": "",
                "product_ver": "1.0.0",
                "product_id": "fqi9xqldlmvpg***",
                "name": "Wi-Fi Socket-vdevo Group",
                "id": 1285211,
                "time": 1676952415,
                "category": "",
                "group_key": ""
            }
        ],
        "page_size": 1
    },
    "t": 1677119365048,
    "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 DocRename Group

Next DocAdd Device