Remove Devices from Group

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

Remove devices from a device group. Up to 20 devices can be removed each time.

API address

POST: /v1.0/iot-03/device-groups/{group_id}/actions/device-remove

Request parameter

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

Description of body

Parameter name	Type	IN	Required	Description
device_ids	List	body	true	The ID sets of devices to be removed.

Return parameter

Parameter name	Type	Description
result	GroupPackageTaskVO	The returned result.

Description of result

Parameter name	Type	Description
group_id	String	The ID of a specified group.
task_id	String	The ID of a specified task.
expire_time	Long	The expiration time in seconds.

Request example

POST: /v1.0/iot-03/device-groups/14308xxxx887268904/actions/device-remove

{
  "device_ids": [
    "vdevo16292xxxx310895"
  ]
}

Return example

{
    "result": {
        "expire_time": 10,
        "task_id": "143253xxxx5458899",
        "group_id": "14308xxxx887268904"
    },
    "t": 1630379063616,
    "success": true
}

Error code

For more information, see error code.

Prev DocDevices Group Management

Next DocDelete Device Group