---
name: "SmartAlarmAbility.getBuiltInAlarmList"
mode: "api"
versionRequirements:
  - { name: "@ray-js/panel-sdk", version: "1.8.0" }
title: "getBuiltInAlarmList - 根据设备 id 查询该产品内置的告警列表信息。"
summary: "根据设备 ID 查询该产品内置的告警消息推送列表信息。"
---

## SmartAlarmAbility.getBuiltInAlarmList

> [VERSION] @ray-js/panel-sdk >= 1.8.0

> 💡 仅支持单设备，不支持群组环境。
> 内置告警由产品在涂鸦 IoT 平台配置，用户只能启用/禁用，不能新增或删除。
> 注意，返回示例仅供参考，其包含字段大于返回参数定义范围，请勿使用除本文返回参数定义以外的返回数据，否则可能会导致程序异常。

### 描述

根据设备 ID 查询该产品内置的告警列表信息

### 参数

`Params`

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `devId` | `string` | 否 | 设备 ID，不传则使用当前设备 |

### 返回值

类型: `Promise<BuiltInAlarmList>`

内置告警列表

### 引用对象

##### `type` BuiltInAlarmList

```typescript
export type BuiltInAlarmList = BuiltInAlarmRule[];
```

##### `type` BuiltInAlarmRule

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `auditStatus` | `number` | 审核状态 |
| `boundForPanel` | `boolean` | 是否被场景面板绑定 |
| `boundForWiFiPanel` | `boolean` | 是否被 WiFi 场景面板绑定 |
| `enabled` | `boolean` | 是否启用 |
| `i18nData` | `BuiltInAlarmI18nData` | 多语言数据体 |
| `id` | `string` | 规则 ID |
| `localLinkage` | `boolean` | 是否为本地联动 |
| `name` | `string` | 规则名称 |
| `newLocalScene` | `boolean` | 是否为 App 管控本地联动 |
| `stickyOnTop` | `boolean` | 场景是否显示在首页 |

##### `type` BuiltInAlarmI18nData

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `name` | `AlarmLocaleText` | 名称多语言 |
| `content` | `AlarmLocaleText` | 内容多语言 |

##### `type` AlarmLocaleText

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `en` | `string` | 英文文案 |
| `zh` | `string` | 中文文案 |


### 示例代码

#### 示例

```typescript
const alarmList = await sdm.alarm.getBuiltInAlarmList();
alarmList.forEach(alarm => {
  console.log(alarm.id, alarm.name, alarm.enabled);
});
```