---
name: "getDpsInfos"
mode: "api"
versionRequirements:
  - { name: "@ray-js/ray", version: "1.5.2" }
title: "getDpsInfos - 获取设备所有 DP 信息"
---

## getDpsInfos

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

### 描述

获取设备所有 DP 信息，通常用于获取设备 DP 名称，配合 updateDpName 使用

### 参数

`Params`

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

### 返回值

类型: `Promise<IGetDpsInfosResponse[]>`

DP 信息数组，每个元素包含 code、dpId、value、time、type、name

##### IGetDpsInfosResponse

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `code` | `string` | DP Code |
| `dpId` | `number` | DP ID |
| `value` | `string` | DP 值 |
| `name` | `string` | DP 名称 |
| `time` | `number` | DP 最近上报时间 |
| `type` | `string` | DP 类型 |

### 引用对象

##### `interface` IGetDpsInfos

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `gwId` | `string` | 网关 ID，直连设备值同 devId，子设备则传网关的设备 ID |
| `devId` | `string` | 设备 ID |


### 示例代码

#### 基础用法

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

getDpsInfos({
  devId: 'vdevo169477319679442',
  gwId: 'vdevo169477319679442',
}).then((res) => {
  console.log('DP 信息:', res);
}).catch((error) => {
  console.error(error);
});
```