SmartAlarmAbility.getCustomAlarmList(options?: GetCustomAlarmListParams)

版本要求:
@ray-js/panel-sdk≥1.8.0

描述

查询自定义创建的告警规则列表

参数

参数类型必填说明
否查询参数

返回值

类型:Promise<CustomAlarmList>
自定义告警规则列表,包含 triggerRuleId、triggerRuleVO、bizDomain、bindId 等信息

引用对象

typeCustomAlarmList
export type CustomAlarmList = CustomAlarmRule[];
typeCustomAlarmRule
属性类型描述
triggerRuleIdstring告警执行的规则 id
触发告警规则的详细信息,详见 AlarmTriggerRuleVO 定义
bizDomainstring业务域标识,在告警 SDK 下固定为 miniAppPanelSDKAlarm
associativeEntityValuestring当 associativeEntityId 不足以区分情况下使用,比如使用的是同一个功能点时又要区分告警类型的情况下,可以使用 DpValue,一般情况下用不到
sourceEntityIdstring和当前告警相关联的设备 ID
namestring名称或备注
iconstring图标
bindIdnumber绑定 ID
associativeEntityIdstring和当前告警相关联的功能点 DP ID
enableboolean是否启用

示例代码

示例

// 获取所有自定义告警
const rules = await sdm.alarm.getCustomAlarmList();
console.log('自定义告警数量:', rules.length);

// 按功能点筛选
const dpRules = await sdm.alarm.getCustomAlarmList({ dpId: '1' });