---
name: "getSceneListV2"
mode: "api"
versionRequirements:
  - { name: "@ray-js/ray", version: "1.5.15" }
title: "getSceneListV2 - 查询家庭下一键执行列表"
---

## getSceneListV2

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

### 描述

查询家庭下一键执行列表，会去掉失效或自动化规则

### 参数

| 属性 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `params` | `Object` | 是 | 查询参数 |

##### getSceneListV2.params 的属性

| 属性 | 类型 | 必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `devId` | `string` | 是 | - | 设备 ID |
| `gid` | `string` | 是 | - | 家庭 ID |
| `containStandardZigBee` | `boolean` | 否 | - | 是否包含标准场景 |


### 返回值

类型: `Promise<ISceneListItemV2[]>`

一键执行类型的联动规则列表

##### ISceneListItemV2

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `actions` | `ISceneAction[]` | 执行动作 |
| `alarmIssue` | `boolean` | 是否为告警问题 |
| `attribute` | `number` | 属性 根据枚举值的2次幂进行位运算 |
| `auditStatus` | `number` | 审核状态 0. 未审核 1. 审核通过 2. 审核不通过 |
| `background` | `string` | 背景图地址 |
| `boundForPanel` | `boolean` | 面板绑定 |
| `boundForWiFiPanel` | `boolean` | WiFi 面板绑定 |
| `code` | `string` | 规则 code |
| `commonField` | `string` | 通用json字段，比如本地联动会存网关id，gwId |
| `containDeviceDelete` | `boolean` | 是否包含已删除的设备 |
| `coverIcon` | `string` | 图标 |
| `description` | `string` | 规则描述 |
| `disableTime` | `number` | 禁用时间戳 |
| `displayColor` | `string` | 背景颜色 |
| `enabled` | `boolean` | 规则是否启用 |
| `forceCloudTrigger` | `boolean` | 是否强制云端触发 |
| `id` | `string` | 执行规则 id |
| `iotAutoAlarm` | `boolean` | 是否为 IoT 自动告警 |
| `isAlarmIssue` | `boolean` | 是否为告警问题 |
| `isLogicRule` | `boolean` | 是否为逻辑规则 |
| `linkageType` | `number` | 联动类型 |
| `localLinkage` | `boolean` | 是否本地联动 |
| `logicRule` | `boolean` | 是否逻辑规则 |
| `matchType` | `number` | 匹配类型 1. 任意条件，多个条件里只要有一个即触发（即 或关系）。 2. 全部满足，多个条件全部满足才触发。 3. 表态式匹配， 根据 rule 字段的 expr 确定是否满足，条件满足时触发。 |
| `name` | `string` | 联动名称或备注 |
| `needCleanGidSid` | `boolean` | 是否需要清理 gidSid |
| `needValidOutOfWork` | `boolean` | 是否需要校验不在工作时间段 |
| `newLocalScene` | `boolean` | 是否为新本地场景 |
| `offGwSync` | `boolean` | 是否离网关同步 |
| `offGwSyncSuccess` | `boolean` | 离网关同步是否成功 |
| `orderWeight` | `number` | 排序权重 |
| `outOfWork` | `number` | 不在工作时间段标记 |
| `ownerId` | `string` | 家庭 id |
| `panelType` | `number` | 面板类型 |
| `permissionCode` | `string` | 权限 code |
| `ruleGenre` | `number` | 规则体裁 |
| `ruleSource` | `number` | 规则来源 |
| `ruleType` | `number` | 规则类型 1. 系统定义 2. 商家定义 3. 用户定义 4. 安防规则 5. 服务定义（如 dp 点转发） |
| `runtimeEnv` | `string` | 运行环境 |
| `scenarioRule` | `boolean` | 是否为场景规则 |
| `status` | `boolean` | 规则状态 |
| `statusConditions` | `any[]` | 状态条件列表 |
| `stickyOnTop` | `boolean` | 是否显示在首页顶部 |
| `subMatchType` | `number` | 子匹配类型 |
| `uid` | `string` | 用户 id |

### 引用对象

##### `interface` ISceneAction

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `actionDisplay` | `string` | 执行动作的显示名称 |
| `actionExecutor` | `string` | 执行动作的执行者 |
| `actionStrategy` | `string` | 执行动作的策略 |
| `attribute` | `number` | 属性值 |
| `devDelMark` | `boolean` | 设备删除标记，表示设备是否被删除 |
| `enabled` | `boolean` | 动作是否启用 |
| `entityId` | `string` | 实体ID，表示动作所属的实体的ID |
| `gmtModified` | `number` | 修改时间戳 |
| `id` | `string` | 动作的唯一ID |
| `offGwSync` | `boolean` | 网关同步标记，表示是否网关同步 |
| `orderNum` | `number` | 动作的顺序号 |
| `ruleId` | `string` | 规则ID，表示动作所属的规则的ID |
| `status` | `boolean` | 动作状态 |
| `uid` | `string` | 用户ID，表示动作所属的用户的ID |


### 示例代码

```typescript
import { getSceneListV2 } from '@ray-js/ray';

const fetchScenes = async () => {
  try {
    const scenes = await getSceneListV2({
      devId: 'device_001',
      gid: '12345678',
      containStandardZigBee: false,
    });
    console.log('一键执行列表:', scenes);
  } catch (err) {
    console.error('查询失败:', err);
  }
};
```