---
name: "cleanDeviceData"
mode: "api"
versionRequirements:
  - { name: "@tuya-miniapp/cloud-api", version: "1.3.0" }
---

## cleanDeviceData

> [VERSION] @tuya-miniapp/cloud-api >= 1.3.0

> 💡 接口依赖云能力，需在[小程序开发者平台](https://platform.tuya.com/miniapp/)开发设置 - 云能力进行授权配置。使用本接口前，请确保设备所属产品已在[涂鸦 IoT 开发平台](https://iot.tuya.com/)开启**电量统计**高级能力。未启用该能力的产品无法采集电量/电费数据，接口将返回空数据或报错。如需使用，请创建带有电量/电费统计功能的产品，并在产品详情中启用相应高级能力。

### 描述

清除指定设备的能源统计数据。操作不可逆，清除后设备的电量、电费等历史统计数据将被清空，建议在调用前提示用户确认。

### 参数

`Params`

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `params` | `CleanDeviceDataParams` | 是 | 请求参数 |

### 返回值

类型: `Promise<boolean>`

是否清除成功；此操作不可逆，建议先调用 exportDeviceData 备份数据后再清除

### 引用对象

##### `interface` CleanDeviceDataParams

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `devId` | `string` | 设备 ID |


### 示例代码

#### 请求示例

```javascript
import { cleanDeviceData } from '@tuya-miniapp/cloud-api';

cleanDeviceData({ devId: 'vdevo123' })
  .then(result => {
    console.log('设备能源数据清除成功:', result);
  })
  .catch(error => {
    console.error('设备能源数据清除失败:', error);
  });
```

#### 返回示例

```json
true
```


### 常见问题

#### 为什么调用云能力会出现失败的情况？

使用本接口前，请确保设备所属产品已在[涂鸦 IoT 开发平台](https://iot.tuya.com/)开启**电量统计**高级能力。未启用该能力的产品无法采集电量/电费数据，接口将返回空数据或报错。如需使用，请创建带有电量/电费统计功能的产品，并在产品详情中启用相应高级能力。同时，接口依赖云能力，需在[小程序开发者平台](https://platform.tuya.com/miniapp/)`开发设置` - `云能力`进行授权配置。