V2.4 Modify Device Status¶
修改设备状态。
支持修改状态为 未激活 和 离线 的设备。设备的状态应以 EnOS 实际连接状态为准,例如,使用此 API 修改一个 离线
状态的设备为 在线
,将导致该设备在页面显示状态为 在线
,而实际处于离线状态,此时可以通过此 API 修改该设备状态。
使用此 API 前,确保已安装 EnOS 2.4.4 及以上版本。
请求参数(Body)¶
注解
以下非必需字段中,必须提供 assetId
,或提供 productKey
和 deviceKey
的组合,用于指定设备。
名称 | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|
status | 必需 | Enum | 设备的状态。有效取值为:inactive 、online 、offline 。 |
assetId | 可选 | String | 资产 ID。如何获取 assetId 信息>> |
productKey | 可选 | String | Product Key。需要与 deviceKey 一起使用。 |
deviceKey | 可选 | String | Device Key。需要与 productKey 一起使用。 |
错误码¶
代码 | 错误信息 | 描述 |
---|---|---|
11404 | Device cannot be found | 该设备不存在。 |
99400 | Invalid arguments: Device information is invalid. | 请求参数中的设备信息不符合规范。需提供 assetId ,或提供 productKey + deviceKey 。 |
99400 | Invalid arguments: Status {status} is not allowed to be modified. |
不支持修改为请求中设置的状态。 |
99400 | Invalid arguments: Unable to modify status as the device is currently connected to EnOS. | 设备此时已连接至 EnOS,无法修改状态。如有需要,可以先关闭设备连接。 |
99400 | Invalid arguments: Unable to modify status for mirrored devices. | 无法修改镜像状态的设备。 |
99400 | Invalid arguments: Unable to modify status for disabled devices. | 无法修改禁用状态的设备。 |