---
name: "setAlarmSwitch"
mode: "api"
versionRequirements:
  - { name: "@ray-js/ray", version: "1.5.2" }
title: "setAlarmSwitch - 启用或者禁用设备的告警。"
---

## setAlarmSwitch

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

### 描述

启用或者禁用设备的告警开关

### 参数

`Params`

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

### 返回值

类型: `Promise<boolean>`

是否设置成功

### 引用对象

##### `interface` ISetAlarmSwitch

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `devId` | `string` | 设备 ID |
| `ruleIds` | `string` | 要开启或关闭的告警规则 ID，多个 ID 用英文逗号隔开 |
| `disabled` | `string` | 是否禁用告警，'true' 表示禁用，'false' 表示启用 |


### 示例代码

#### 基础用法

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

setAlarmSwitch({
  devId: 'vdevo169477319679442',
  ruleIds: '123456,789012',
  disabled: 'false',
}).then((res) => {
  console.log('设置结果:', res);
}).catch((error) => {
  console.error(error);
});
```