Creating a Device Group

Updated on 2022-02-24 GMT+08:00

View PDF

Typical Scenario

An NA can call this API to create device groups on the IoT platform, and allocate devices to different device groups for group management. A device can be bound to multiple device groups.

When the NA needs to perform operations on devices (such as upgrading device software and firmware or delivering commands to devices in batches), the NA can select devices to be operated by device group.

API Function

This API is used by an NA to create device groups on the IoT platform to manage devices by group.

API Description

1	public function createDeviceGroup($cdgInDTO, $accessToken)

Parameter Description

Parameter	Mandatory or Optional	Location	Description
$cdgInDTO	Mandatory	body	For details, see CreateDeviceGroupInDTO structure.
$accessToken	Mandatory	header	This parameter is set to the value of the access token obtained by calling the Authentication API.

CreateDeviceGroupInDTO

Parameter	Mandatory or Optional	Location	Description
$name	Mandatory	body	Indicates the device group name. The value can contain only uppercase and lowercase letters and digits.
$description	Optional	body	Indicates the device group description.
$appId	Optional	body	If the device belongs to the current application, set this parameter to null. Otherwise, set this parameter to the ID of the authorized application.
$maxDevNum	Optional	body	Indicates the maximum number of devices in a device group. The default value is 0. If the value is 0, the number of devices is not limited.
$deviceIds	Optional	body	Identifies the devices to be added to the device group.
id	Optional	body	Identifies a device group.

Response Parameters

StatusCode: 200 ok

CreateDeviceGroupOutDTO

Parameter	Description
$name	Indicates the device group name. The value can contain only uppercase and lowercase letters and digits.
$description	Indicates the device group description.
$id	Identifies a device group. The device group ID is automatically generated by the IoT platform.
$appId	Uniquely identifies an NA.
$maxDevNum	Indicates the maximum number of devices in the device group. If the value is 0, the number of devices is not limited.
curDevNum	Indicates the current number of devices in the device group.
deviceIds	Identifies the devices to be added to the device group.

Error Codes

HTTP Status Code	Error Code	Error Description	Remarks
200	100203	The application is not existed.	The application does not exist. Recommended handling: Check whether appId carried in the HTTP request header is correct. Check whether appId in the request path (URL) is correct.
200	100217	The application hasn't been authorized.	The application has not been authorized. Recommended handling: In scenarios where applications are not authorized, ensure that request parameter appId is null.
200	100602	The device group name has been used.	The device group name exists. Recommended handling: Change the device group name in the API request.
200	100607	The devGroup has reached the limit.	The number of device groups reaches the limit. Recommended handling: Check whether the number of created device groups reaches the upper limit specified in the license.
400	100609	Too much devices to add.	Too many devices are added to the device group. Recommended handling: Ensure that the number of device IDs contained in deviceIds is within the range specified by maxDevNum.
400	50400	The input is invalid.	An input parameter is invalid. Recommended handling: Check whether parameters carried in the API call request are valid.
403	1010009	app throttle exceed.	The NA calls the API at a frequency that exceeds the flow control threshold (100 calls per minute by default). Recommended handling: Contact IoT platform maintenance personnel to adjust the flow control threshold or control the API call frequency.
403	1010005	App_key or access_token is invalid.	The access token is invalid. Recommended handling: Check whether accessToken carried in the API request is correct.
500	50252	Internal server error.	An internal server error occurs. Recommended handling: An internal error occurs on the IoT platform. Contact IoT platform maintenance personnel.