设备接入 IoTDA设备接入 IoTDA

更新时间:2021/09/06 GMT+08:00
分享

管理设备组中的设备

接口说明

应用服务器可调用此接口管理设备组中的设备。单个设备组内最多添加20,000个设备,一个设备最多可以被添加到10个设备组中。

调试

您可以在API Explorer中调试该接口。

URI

请求方法

POST

URI

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

传输协议

HTTPS

请求参数

名称

必选/可选

类型

位置

说明

X-Auth-Token

必选

String

Header

参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证

Instance-Id

可选

String

Header

参数说明:实例ID。物理多租下各实例的唯一标识,一般华为云租户无需携带该参数,仅在物理多租场景下从管理面访问API时需要携带该参数。

project_id

必选

String

Path

参数说明:项目ID。获取方法请参见 获取项目ID

group_id

必选

String

Path

参数说明:设备组ID,用于唯一标识一个设备组,在创建设备组时由物联网平台分配。

取值范围:长度不超过36,十六进制字符串和连接符(-)的组合

action_id

必选

String

Query

参数说明:操作类型,支持添加设备和删除设备。

取值范围

  • addDevice: 添加设备。添加已注册的设备到指定的设备组中。
  • removeDevice: 删除设备。从指定的设备组中删除设备,只是解除了设备和设备组的关系,该设备在平台仍然存在。

device_id

必选

String

Query

参数说明:设备ID,用于唯一标识一个设备。在注册设备时直接指定,或者由物联网平台分配获得。由物联网平台分配时,生成规则为"product_id" + "_" + "node_id"拼接而成。

取值范围:长度不超过128,只允许字母、数字、下划线(_)、连接符(-)的组合。

请求示例

POST https://{Endpoint}/v5/iot/{project_id}/device-group/{group_id}/action?action_id={action_id}&device_id={device_id}
Content-Type: application/json
X-Auth-Token: ********
Instance-Id: ********

响应示例

Status Code: 200 OK

错误码

HTTP状态码

错误码

错误码英文描述

错误码中文描述

处理建议

403

IOTDA.000021

Operation not allowed. User not found by IAM token or the authorized user has not subscribed IOTDA service.

没有找到IAM Token所对应的用户信息或该用户没有订阅设备接入服务(IOTDA)

请排查IAM Token所在用户是否订阅了设备接入服务(IOTDA)。

IOTDA.000022

Operation not allowed. The user does not have the permission

该用户没有权限

请排查该用户是否有权限访问。

IOTDA.001006

Operation not allowed. Application not found by authorized user or the authorized user has no application.

用户下没有应用或应用与用户不匹配

请排查用户下是否有应用或是否有指定的应用。

IOTDA.001007

Operation not allowed. The application does not belong to the authorized user.

应用与用户信息不匹配

请排查该用户下是否有指定的应用。

IOTDA.003005

Operation not allowed. The device to be added has been exist in the group.

该设备在设备组中已存在

该设备在设备组中已存在,无需再次添加。

IOTDA.003006

Operation not allowed. The device to be deleted not exist in the group.

该设备在设备组中不存在

该设备在设备组中不存在,无需删除。

IOTDA.003007

Operation not allowed. The number of devices in this group has reached or exceed 20000.

设备组中的设备数量达到最大限制20000

请删除多余设备或更换群组。

IOTDA.003008

Operation not allowed. The number of groups added this device has reached or exceed 10.

一个设备最多只能添加到10个设备组中

请将该设备从多余的群组中删除后重试,该设备所在群组已达到最大限制。

IOTDA.003011

Operation not allowed. The group and the device does not belong to the same application.

群组和设备不属于同一个应用。

请使用相同应用下的群组和设备进行操作。

404

IOTDA.003000

The group does not exist.

群组不存在

请确认是否有该设备组或设备组参数是否携带正确。

IOTDA.014000

The device does not exist.

设备不存在

请排查请求参数是否有误并确认是否有在平台注册该设备。

500

IOTDA.000001

Internal server error.

服务器内部错误

请联系华为工程师分析解决。

分享:

    相关文档

    相关产品