设备添加定时任务

更新时间：2023-12-07 03:33:55下载pdf

本文介绍设备添加定时任务的 API。

接口描述

该接口为设备添加定时任务。通过参数 loops，可分为循环定时任务与非循环定时任务。
循环定时：以一周为循环，可设定周一到周日的循环定时。
非循环定时：设定指定时间节点的定时任务，接口会对设定的时间节点做限定。该时间节点需要在当前时间之后，否则无法创建定时任务，并提示定时任务已过期。

接口地址

POST: /v1.0/devices/{devId}/timers

请求参数

参数名	类型	参数位置	是否必填	说明
devId	String	uri	true	设备 ID。

body 说明

参数名	类型	参数位置	是否必填	说明
category	String	body	true	定时分类。
loops	String	body	true	定时任务的执行时间。由 `0` 和 `1` 组成的七位数字。`0` 代表关闭，`1` 代表开启。
time_zone	String	body	true	时区。
timezone_id	String	body	true	时区 ID。
instruct	object	body	true	定时任务具体的时间和设备指令，⽀持同时设置多个定时任务。
alias_name	String	body	false	别名。

返回参数

参数名	类型	说明
result	Object	返回任务创建结果。
success	Boolean	操作是否成功。 `true`：操作成功。 `false`：操作失败。
t	Boolean	时间戳。
tid	Boolean	链路 ID。

result 说明

参数名	类型	说明
group_id	Long	定时任务 ID。

请求示例

POST: /v1.0/devices/vdevo15445800464****/timers

{
  "category": "timer",
  "timezone_id": "Europe/Berlin",
  "timezone": "+1:00",
  "alias_name": "Guten Morgen",
  "instruct": [
    {
      "functions": [
        {
          "code": "feed_num",
          "value": 3
        }
      ],
      "date": "",
      "time": "6:0"
    }
  ],
  "loops": "1111111"
}

返回示例

{
    "tid": "c3d213a97df711eea3b2361f0317****",
    "result": {
        "group_id": "000169942135****"
    },
    "t": 1699421359166,
    "success": true
}

错误码

参考错误码。