Updated on 2024-01-26 GMT+08:00

Modify a Device Group

Function

This API is used by an application to modify a specific device group on the platform.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

PUT /v5/iot/{project_id}/device-group/{group_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Parameter description: project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

group_id

Yes

String

Parameter description: device group ID. The ID is unique and is allocated by the platform during device group creation. Value: The value can contain a maximum of 36 characters, including hexadecimal strings and hyphens (-).

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

Parameter description: user token. You can obtain the token by calling the IAM API Obtaining a User Token Through Password Authentication. X-Subject-Token in the response header returned by the API is the desired user token. For details about how to obtain the token, see Token Authentication.

Instance-Id

No

String

Parameter description: instance ID. Unique identifier of each instance in the physical multi-tenant scenario. Mandatory for professional editions and recommended in other cases. Log in to the IoTDA console and choose Overview in the navigation pane to view the instance ID. For details, see Viewing Instance Details.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

No

String

Parameter description: device group name, which must be unique in a single resource space. Value: The value can contain a maximum of 64 characters. Only letters, digits, underscores (_), and question marks (?) are allowed. '#().,& %@!-.

Minimum: 1

Maximum: 64

description

No

String

Parameter description: device group description. Value: The value can contain a maximum of 64 characters. Only letters, digits, underscores (_), and question marks (?) are allowed. '#().,& %@!-.

Minimum: 1

Maximum: 64

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

group_id

String

Device group ID. The ID is unique and is allocated by the platform during device group creation.

name

String

Device group name, which must be unique in a single resource space.

description

String

Device group description.

super_group_id

String

ID of the parent device group.

group_type

String

Device group type, which can be dynamic or static.

dynamic_group_rule

String

Dynamic device group rule.

Example Requests

Changes the name of the device group to GroupA.

PUT https://{endpoint}/v5/iot/{project_id}/device-group/{group_id}

{
  "name" : "GroupA",
  "description" : "GroupA"
}

Example Responses

Status code: 200

OK

{
  "group_id" : "04ed32dc1b0025b52fe3c01a27c2babc",
  "name" : "GroupA",
  "description" : "GroupA",
  "super_group_id" : "04ed32dc1b0025b52fe3c01a27c2b0a8",
  "group_type" : "STATIC",
  "dynamic_group_rule" : null
}

Status Codes

Status Code

Description

200

OK

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.