---
name: "updateDpName"
mode: "api"
versionRequirements:
  - { name: "@ray-js/ray", version: "1.5.2" }
title: "updateDpName - 更新设备 DP 名称"
---

## updateDpName

> [VERSION] @ray-js/ray >= 1.5.2

### 描述

更新设备 DP 名称

### 参数

`Params`

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

### 返回值

类型: `Promise<boolean>`

是否成功更新

### 引用对象

##### `interface` IUpdateDpName

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `devId` | `string` | 设备 ID |
| `dpId` | `string` | DP ID |
| `name` | `string` | DP 自定义名称 |
| `gwId` | `string` | 网关 ID，可不传 |


### 示例代码

#### 基础用法

```ts
import { updateDpName } from '@ray-js/ray';

updateDpName({
  devId: 'vdevo169477319679442',
  dpId: '21',
  name: 'work_mode',
}).then((res) => {
  console.log('更新结果:', res);
}).catch((error) => {
  console.error(error);
});
```
