Modifying a Device Group

Typical Scenario

If information about a device group (such as the device group name and the device quantity limit in the device group) needs to be modified due to service changes, an NA can call this API to modify the information.

API Function

This API is used by an NA to modify information about a specified device group on the IoT platform.

API Prototype

Method	PUT
URL	https://server:port/iocm/app/devgroup/v1.3.0/devGroups/{devGroupId}?accessAppId={accessAppId}
Transport Protocol	HTTPS

Request Parameters

Parameter	Mandatory or Optional	Type	Location	Description
app_key	Mandatory	String	header	Identifies an application that can be accessed on the IoT platform. The value of this parameter is allocated by the IoT platform when the application is created on the platform.
Authorization	Mandatory	String	header	Indicates the authentication information for accessing the IoT platform. The value is Bearer {accessToken}, in which {accessToken} indicates the access token returned by the Authentication API.
accessAppId	Optional	String	query	This parameter must be specified when you want to modify information about a device group under an authorized application. Set this parameter to the ID of the authorized application.
devGroupId	Mandatory	String (50)	path	Identifies a device group. The value of this parameter is returned by the IoT platform after the device group is added.
name	Mandatory	String(1-50)	body	Indicates the device group name. The value can contain only uppercase and lowercase letters and digits.
description	Optional	String(1024)	body	Indicates the device group description.
maxDevNum	Optional	Integer(>=0)	body	Indicates the maximum number of devices in the device group. The default value is 0. If the value is 0, the number of devices is not limited.

Response Parameters

Status Code: 200 OK

Parameter	Type	Description
name	String(50)	Indicates the device group name. The value can contain only uppercase and lowercase letters and digits.
description	String(1024)	Indicates the device group description.
id	String(50)	Identifies a device group.
appId	String(50)	Identifies the application to which the device group belongs.
maxDevNum	Integer(>=0)	Indicates the maximum number of devices in the device group. If the value is 0, the number of devices is not limited.
curDevNum	Integer	Indicates the current number of devices in the device group.

Request Example

Method: PUT
Request:
https://server:port/iocm/app/devgroup/v1.3.0/devGroups/{devGroupId}?accessAppId={accessAppId}
Header:
app_key: ******
Authorization: Bearer ******
Content-Type: application/json
Body:
{
  "name": "********",
  "description": "******",
  "maxDevNum": "********"
}

Response Example

Response:
Status Code: 200 OK
Content-Type: application/json
Body:
{
  "name": "********",
  "description": "******",
  "id": "********",
  "appId": "********",
  "maxDevNum": "********",
  "curDevNum": "********"
}

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	100601	The number of device in the group has reach the max.	The number of devices in the device group reaches the upper limit. Recommended handling: Ensure that the number of devices in the device group is within the range specified by maxDevNum.
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	100603	The device group is not existed.	The device group does not exist. Recommended handling: Check whether the device group ID is correct.
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.