查询自动化详情

本文介绍查询自动化详情的 API。

接口描述

根据自动化 ID 查询自动化详情。

接口地址

GET: /v2.0/iot-03/automations/{automation_id}

请求参数

参数名	类型	参数位置	是否必填	说明
automation_id	String	uri	true	自动化 ID

返回参数

参数名	类型	说明
result	AutomationDetailRes	返回结果

result 说明

参数名	类型	说明
name	String	自动化名称
dsl	AutomationDSLRes	自动化规则语言
preconditions	LinkagePreconditionsRes	自动化执行前置条件
status	Integer	自动化启用状态： 0：停用 1：启用
automation_type	String	自动化类型。 local：本地自动化 lan：局域网自动化 cloud：云端自动化

preconditions 说明

参数名	类型	说明
trigger_type	String	触发类型
precondition_trigger_rule	PreconditionTriggerRuleRes	前置条件触发规则。见 precondition_trigger_rule 详细说明。

dsl 说明

参数名	类型	说明
conditions_rule	String	自动化条件匹配规则
conditions	List	自动化条件列表
actions	List	自动化动作列表

conditions 说明

参数名	类型	说明
trigger_type	String	条件触发类型
trigger_id	String	条件触发 ID
rule_num	Integer	触发条件编号
trigger_rule	ConditionTriggerRuleRes	条件触发规则。见trigger_rule详细说明

actions 说明

参数名	类型	说明
execution_type	String	执行类型
execution_rule	ActionExecutionRuleRes	执行规则。见 execution_rule 详细说明。

请求示例

GET: /v2.0/iot-03/automations/7MShiTZq1tih****

返回示例

{
    "result": {
        "automation_type": "cloud",
        "preconditions": {
            "trigger_type": "timeCheck",
            "precondition_trigger_rule": {
                "timer_format": "09:00-23:00 * * 0,1,2,3,4,5,6 *"
            }
        },
        "name": "这是一个自动化",
        "dsl": {
            "conditions_rule": "or",
            "conditions": [
                {
                    "rule_num": 1,
                    "trigger_rule": {
                        "status_code": "switch_1",
                        "status_value": false,
                        "comparator": "=="
                    },
                    "trigger_id": "vdevo16275516176****",
                    "trigger_type": "deviceReport"
                },
                {
                    "rule_num": 2,
                    "trigger_rule": {
                        "timer_format": "17:50 18 10 * 2021"
                    },
                    "trigger_id": "timer",
                    "trigger_type": "timer"
                },
                {
                    "rule_num": 3,
                    "trigger_rule": {
                        "weather_value": 20,
                        "comparator": "<=",
                        "weather_code": "temp"
                    },
                    "trigger_id": "79340958999865****",
                    "trigger_type": "weather"
                }
            ],
            "actions": [
                {
                    "execution_rule": {
                        "delay_seconds": 10
                    },
                    "execution_type": "delay"
                },
                {
                    "execution_rule": {
                        "execution_id": "vdevo16275516363****",
                        "function_value": 100,
                        "function_code": "bright_value"
                    },
                    "execution_type": "deviceIssue"
                },
                {
                    "execution_rule": {
                        "execution_id": "144790134147200****",
                        "function_value": true,
                        "function_code": "child_lock"
                    },
                    "execution_type": "deviceGroupIssue"
                },
                {
                    "execution_rule": {
                        "execution_id": "144790134147200****",
                        "function_value": true,
                        "function_code": "child_lock"
                    },
                    "execution_type": "deviceGroupIssue"
                }
            ]
        },
        "status": 1
    },
    "t": 1635404735404,
    "success": true
}

错误码

参考 错误码。

trigger_rule详细说明

1、当 trigger_type 为deviceReport时：

参数名	类型	说明	必填
status_code	String	设备指令	是
comparator	String	比较符	是
status_value	Object	设备指令值	是

2、当 trigger_type 为timer时：

参数名	类型	说明	必填
timer_format	String	定时触发时间。支持两种格式： 指定日期定时，格式为： [hour:min] [day of month] [month] [day of week] [year]，例如：20:00 20 10 * 2021（2021年10月20号晚上8点） 按周循环定时，格式为： [hour:min] [day of month] [month] [day of week] [year]，例如：20:00 * * 0,1,2,3 *（每周日、周一、周二、周三晚上8点）	是

3、当trigger_type为weather时：

参数名	类型	说明	必填
weather_code	String	天气码	是
comparator	String	比较符	是
weather_value	Object	天气码值	是

execution_rule详细说明

1、当execution_type为delay时：

参数名	类型	说明	必填
delay_seconds	Long	延时时间，取值范围 1~5 * 60 * 60，单位：秒	是

2、当execution_type为deviceIssue或deviceGroupIssue时：

参数名	类型	说明	必填
execution_id	String	设备或设备群组 ID	是
function_code	String	设备或设备群组指令码	是
function_value	Object	设备或设备群组指令值	是

precondition_trigger_rule 详细说明

参数名	类型	描述	必填
timer_format	String	定时格式。格式为： [hour:min]-[hour:min] [day of month] [month] [day of week] [year]，例如： 9:30-18:00 * * 0,1,2,3,4,5,6 * (每周上午9点半到下午6点)	否