---
name: "getSceneList"
mode: "api"
versionRequirements:
  - { name: "基础库", version: "2.14.0" }
title: "device.getSceneList - 查询联动规则列表"
---

## getSceneList

> [VERSION] 基础库 >= 2.14.0

### 描述

查询家庭下联动规则列表，包含失效及自动化规则

### 参数

`Params`

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `params` | `IGetSceneListOption` | 是 | 查询参数，包含设备 ID 和家庭 ID |

### 返回值

类型: `Promise<ISceneListItem[]>`

联动规则列表

##### ISceneListItem

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `actions` | `any[]` | 执行动作列表 |
| `attribute` | `number` | 属性，根据枚举值的2次幂进行位运算 |
| `auditStatus` | `number` | 审核状态 |
| `background` | `string` | 背景图地址 |
| `boundForPanel` | `boolean` | 是否面板绑定 |
| `boundForWiFiPanel` | `boolean` | 是否 WiFi 面板绑定 |
| `code` | `string` | 规则 code |
| `commonField` | `string` | 通用 json 字段 |
| `coverIcon` | `string` | 图标 |
| `disableTime` | `number` | 禁用时间 |
| `displayColor` | `string` | 背景颜色 |
| `enabled` | `true` | 规则是否启用 |
| `devId` | `string` | 设备 ID |
| `name` | `string` | 联动名称 |
| `id` | `string` | 规则 ID |

### 引用对象

##### `interface` IGetSceneListOption

| 属性 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `devId` | `string` | 是 | 设备 ID |
| `gid` | `string` | 是 | 家庭 ID |


### 示例代码

#### 获取场景列表

```ts
ty.getSceneList({
  devId: 'abc123',
  gid: '456789',
}).then((list) => {
  console.log('场景列表', list);
});
```