获取联动规则详情

更新时间:2024-06-29 01:58:54下载pdf

本文介绍获取联动规则详情的 API。

接口描述

根据联动规则 ID,获取联动规则详情。

接口地址

GET: /v2.0/cloud/scene/rule/{rule_id}

请求参数

参数名类型参数位置是否必填说明
rule_idStringuritrue联动规则 ID。

返回参数

参数名类型说明
resultLinkageResponse返回结果。

result 说明

参数名类型说明
idString联动规则 ID。
statusString状态。
  • enable:启用联动规则。
  • disable:禁用联动规则。
running_modeString运行模式。
  • local:本地联动。
  • lan:局域网联动。
  • cloud:云端联动。
space_idString联动关联空间 ID。
nameString名称。
typeString联动类型。
  • scene:一键执行。
  • automation:自动化。
decision_exprString条件表达式。
  • and:且。
  • or:或。
  • c1&c2:自定义表达式。
conditionsList条件集合。
actionsList动作集合。
effective_timeEffectiveTime生效时间。

effective_time 说明

参数名类型说明
startString开始时间。
endString结束时间。
loopsString联动规则触发周期,由 01 组成的 7 位数字。0 表示不执行,1 表示执行。第 1 位为周日,依次表示周一至周六。例如,0011000 表示每周二和周三执行。
time_zone_idString时区 ID。

conditions 说明

参数名类型说明
entity_idString条件对象 ID。
entity_typeString条件对象类型。
  • timer:定时。
  • weather:天气。
  • device_report:设备上报。
codeInteger条件编码,不可重复。
exprExpr计算表达式。

actions 说明

参数名类型说明
entity_idString动作对象 ID。
action_executorString动作对象类型。
  • delay:延时。
  • device_issue:设备指令下发。
  • device_group_issue:群组指令下发。
executor_propertyExecutorProperty动作明细。

expr 说明

参数名类型说明
status_codeString状态集 code。当 entity_typedevice_report 时,此参数必填。
comparatorString比较表达式。当 entity_typedevice_reportweather 时,此参数必填。
  • ==:等于。
  • >:大于。
  • <:小于。
status_valueObject状态集 value。当 entity_typedevice_report 时,此参数必填。
dateString联动规则触发日期。
timeString联动规则触发时间。
loopsString联动规则触发周期,由 01 组成的 7 位数字。0 表示不执行,1 表示执行。第 1 位为周日,依次表示周一至周六。例如,0011000 表示每周二和周三执行。
time_zone_idString时区 ID。
weather_codeString状态集 code。当 entity_typeweather 时,此参数必填。
weather_valueObject状态集 value。当 entity_typeweather 时,此参数必填。

executor_property 说明

参数名类型说明
function_codeString指令 code。当 action_executordevice_issuedevice_group_issue 时,此参数必填。
function_valueObject指令 value。当 action_executordevice_issuedevice_group_issue 时,此参数必填。
delay_secondsInteger延时时间。当 action_executordelay 时,此参数必填。

请求示例

GET: /v2.0/cloud/scene/rule/***

返回示例

{
    "tid": "c4b2df2ebbcc11eda71e169efc83a172",
    "result": {
        "effective_time": {
            "start": "00:00",
            "loops": "1111111",
            "end": "23:00",
            "time_zone_id": "Asia/Shanghai"
        },
        "type": "automation",
        "running_mode": "cloud",
        "name": "测试联动",
        "decision_expr": "or",
        "id": "***",
        "conditions": [
            {
                "code": 1,
                "entity_id": "***",
                "entity_type": "device_report",
                "expr": {
                    "status_code": "switcn_1",
                    "status_value": "true",
                    "comparator": "=="
                }
            }
        ],
        "actions": [
            {
                "entity_id": "***",
                "executor_property": {
                    "function_value": true,
                    "function_code": "switch_1"
                },
                "action_executor": "device_issue"
            }
        ],
        "space_id": "150***",
        "status": "disable"
    },
    "t": 1678072367076,
    "success": true
}

错误码

参考 错误码

调用频率限制

参考 调用频率限制