Updated on 2024-12-02 GMT+08:00

Manage Devices in a Device Group

Function

This API is used by an application to manage devices in a device group. Up to 20,000 devices can be added to a device group. A device can be added to up to 10 device groups.

Debugging

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

URI

POST /v5/iot/{project_id}/device-group/{group_id}/action

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 (-).

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

action_id

Yes

String

Parameter description: operation type. You can add or delete a device.

Options:

  • addDevice: Add a registered device to a specific device group.

  • removeDevice: Remove a device from a specific device group. This operation only removes the relationship between the device and the device group. The device still exists on the platform.

device_id

Yes

String

Parameter description: device ID, which uniquely identifies a device. The value of this parameter is specified during device registration or allocated by the platform.

Value: The value can contain a maximum of 128 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

Request Parameters

Table 3 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.

Response Parameters

None

Example Requests

  • Manages devices in a device group and adds devices to the device group.

    POST https://{endpoint}/v5/iot/{project_id}/device-group/{group_id}/action?action_id=addDevice&device_id=yourDeviceId
  • Manages devices in a device group and removes devices from the device group.

    POST https://{endpoint}/v5/iot/{project_id}/device-group/{group_id}/action?action_id=removeDevice&device_id=yourDeviceId

Example Responses

None

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.