跳至主要內容

设备与任务

大约 13 分钟

设备与任务

新建设备与任务

POST/admin-api/iot/device-job-relation/create

请求数据类型 ：application/json;charset=UTF-8

请求参数

参数名称参数说明请求类型是否必须数据类型
jobScheduleType任务调度类型；1：设备批量调用服务；2：设备批量设备属性；3：设备批量消息推送jsontruestring
jobTarget任务目标设备；设备id，多个任务目标请用逗号隔开jsontruestring
jobTargetRule任务目标规则见下文jsontruestring
jobDesc任务描述jsontruestring
author负责人jsontruestring
alarmEmail邮箱通知jsonfalsestring
scheduleType调度类型；1：CRON；2：固定速度jsontrueint
scheduleConf调度配置；当scheduleType=1时，此值填cron表达式；当scheduleType=2时，此值填速度，单位为秒jsontruestring
misfireStrategy过期调度策略；DO_NOTHING：忽略；FIRE_ONCE_NOW：立即执行一次jsonfalseint
executorTimeout任务执行超时时间，单位秒jsonfalseint
executorFailRetryCount失败重试次数jsonfalseint
triggerStatus调度状态，：1开启；0：停止jsontrueint
Authorization认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda)
获取access_token请参考获取访问令牌		headertruestring
任务目标规则
1、执行类型为：设备批量调用服务任务规则 ：
{
    "identifier": ${identifier},
    "inputParams": {  
        "params1": ${params1},
        "params2": ${params2},
        ...  
	}
}
2、执行类型为：设备批量设置属性任务规则 ：{"color":"red","prop2":223}
3、执行类型为：设备批量消息推送任务规则 ：{"topicShortName":"test","messageContent":"123"}

参数请求模版

{
  "jobScheduleType": 1,
  "jobTarget": "1420630729179136,1417640527249408",
  "jobTargetRule": "{\n  \"identifier\": \"power_on_service\",\n  \"inputParams\": {\n    \"params1\": 12,\n    \"params2\": 45\n  }\n}",
  "alarmEmail": "1720189720@qq.com",
  "jobDesc": "开机设备与任务",
  "author": "小李子科技",
  "scheduleType": "CRON",
  "scheduleConf": "3 * * * * ?",
  "misfireStrategy": "DO_NOTHING",
  "executorTimeout": "10",
  "executorFailRetryCount": "2",
  "triggerStatus": 1,
  "handlerName": "deviceServiceCallJob"
}

响应状态

状态码说明
200OK

响应参数

参数名称参数说明数据类型
status状态码，值为0正常，其他值为异常int
code结果同status一样，冗余字段int
data创建成功返回Idlong
msg状态消息string

响应示例

{
  "status": 0,
  "code": 0,
  "data": 1419193028346640,
  "msg": ""
}

更新设备与任务

PUT/admin-api/iot/device-job-relation/update

请求数据类型 ：application/json;charset=UTF-8

请求参数

参数名称参数说明请求类型是否必须数据类型
id要更新的设备与任务idjsontruelong
jobScheduleType任务调度类型；1：设备批量调用服务；2：设备批量设备属性；3：设备批量消息推送jsonfalsestring
jobTarget任务目标设备；设备id，多个任务目标请用逗号隔开jsonfalsestring
jobTargetRule任务目标规则见下文jsonfalsestring
jobDesc任务描述jsonfalsestring
author负责人jsonfalsestring
alarmEmail邮箱通知jsonfalsestring
scheduleType调度类型；1：CRON；2：固定速度jsonfalseint
scheduleConf调度配置；当scheduleType=1时，此值填cron表达式；当scheduleType=2时，此值填速度，单位为秒jsonfalsestring
misfireStrategy过期调度策略；DO_NOTHING：忽略；FIRE_ONCE_NOW：立即执行一次jsonfalseint
executorTimeout任务执行超时时间，单位秒jsonfalseint
executorFailRetryCount失败重试次数jsonfalseint
triggerStatus调度状态，：1开启；0：停止jsonfalseint
Authorization认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda)
获取access_token请参考获取访问令牌		headertruestring
任务目标规则
1、执行类型为：设备批量调用服务任务规则 ：
{
    "identifier": ${identifier},
    "inputParams": {  
        "params1": ${params1},
        "params2": ${params2},
        ...  
	}
}
2、执行类型为：设备批量设置属性任务规则 ：{"color":"red","prop2":223}
3、执行类型为：设备批量消息推送任务规则 ：{"topicShortName":"test","messageContent":"123"}

响应状态

状态码说明
200OK

响应参数

参数名称参数说明数据类型
status状态码，值为0正常，其他值为异常int
code结果同status一样，冗余字段int
data更新成功返回trueboolean
msg状态消息string

响应示例

{
  "status": 0,
  "code": 0,
  "data": true,
  "msg": ""
}

获取设备与任务

GET/admin-api/iot/device-job-relation/get

请求数据类型 ：application/json;charset=UTF-8

请求参数

参数名称参数说明请求类型是否必须数据类型
id设备与任务idquerytruelong
Authorization认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda)
获取access_token请参考获取访问令牌		headertruestring

响应状态

状态码说明
200OK

响应参数

参数名称参数说明数据类型
status状态码，值为0正常，其他值为异常int
code结果同status一样，冗余字段int
data数据体object
---id设备与任务idlong
---jobScheduleType任务调度类型；1：设备批量调用服务；2：设备批量设备属性；3：设备批量消息推送string
---jobTarget任务目标设备；设备id，多个任务目标请用逗号隔开string
---jobTargetRule任务目标规则string
---jobDesc任务描述string
---author负责人string
---alarmEmail邮箱通知string
---scheduleType调度类型；1：CRON；2：固定速度int
---scheduleConf调度配置；当scheduleType=1时，此值填cron表达式；当scheduleType=2时，此值填速度，单位为秒string
---misfireStrategy过期调度策略；DO_NOTHING：忽略；FIRE_ONCE_NOW：立即执行一次string
---executorTimeout任务执行超时时间，单位秒int
---executorFailRetryCount失败重试次数int
---triggerStatus调度状态，：1开启；0：停止int
msg状态消息string

响应示例

{
  "status": 0,
  "code": 0,
  "data": {
    "id": 1420692966367232,
    "createTime": 1734244344000,
    "jobDesc": "开机设备与任务",
    "author": "小李子科技",
    "alarmEmail": "1720189720@qq.com",
    "scheduleType": "CRON",
    "scheduleConf": "3 * * * * ?",
    "misfireStrategy": "FIRE_ONCE_NOW",
    "executorTimeout": 10,
    "executorFailRetryCount": 2,
    "triggerStatus": 0,
    "triggerLastTime": 0,
    "triggerNextTime": 0,
    "jobScheduleType": 1,
    "jobTarget": "1420630729179136,1417640527249408",
    "jobTargetRule": "{\n  \"identifier\": \"power_on_service\",\n  \"inputParams\": {\n    \"params1\": 12,\n    \"params2\": 45\n  }\n}"
  },
  "msg": "" 
}

获取设备与任务列表

GET/admin-api/iot/device-job-relation/list

请求数据类型 ：application/json;charset=UTF-8

请求参数

参数名称参数说明请求类型是否必须数据类型
jobScheduleType任务调度类型；1：设备批量调用服务；2：设备批量设备属性；3：设备批量消息推送jsonfalsestring
createTime创建时间时间范围，示例值（2024-11-12 00:00:00 - 2024-11-29 23:59:59）queryfalsearray[datatime]
Authorization认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda)
获取access_token请参考获取访问令牌		headertruestring

响应状态

状态码说明
200OK

响应参数

参数名称参数说明数据类型
status状态码，值为0正常，其他值为异常int
code结果同status一样，冗余字段int
data查询成功后返回数据列表array
---id设备与任务idlong
---jobScheduleType任务调度类型；1：设备批量调用服务；2：设备批量设备属性；3：设备批量消息推送string
---jobTarget任务目标设备；设备id，多个任务目标请用逗号隔开string
---jobTargetRule任务目标规则string
---jobDesc任务描述string
---author负责人string
---alarmEmail邮箱通知string
---scheduleType调度类型；1：CRON；2：固定速度int
---scheduleConf调度配置；当scheduleType=1时，此值填cron表达式；当scheduleType=2时，此值填速度，单位为秒string
---misfireStrategy过期调度策略；DO_NOTHING：忽略；FIRE_ONCE_NOW：立即执行一次string
---executorTimeout任务执行超时时间，单位秒int
---executorFailRetryCount失败重试次数int
---triggerStatus调度状态，：1开启；0：停止int
msg状态消息string

响应示例

{
  "status": 0,
  "code": 0,
  "data": [
    {
        "id": 1420692966367232,
        "createTime": 1734244344000,
        "jobDesc": "开机设备与任务",
        "author": "小李子科技",
        "alarmEmail": "1720189720@qq.com",
        "scheduleType": "CRON",
        "scheduleConf": "3 * * * * ?",
        "misfireStrategy": "FIRE_ONCE_NOW",
        "executorTimeout": 10,
        "executorFailRetryCount": 2,
        "triggerStatus": 0,
        "triggerLastTime": 0,
        "triggerNextTime": 0,
        "jobScheduleType": 1,
        "jobTarget": "1420630729179136,1417640527249408",
        "jobTargetRule": "{\n  \"identifier\": \"power_on_service\",\n  \"inputParams\": {\n    \"params1\": 12,\n    \"params2\": 45\n  }\n}"
    }
  ],
  "msg": ""
}

获取设备任务与分页

GET/admin-api/iot/device-info/page

请求数据类型 ：application/json;charset=UTF-8

请求参数

参数名称参数说明请求类型是否必须数据类型
pageNo页码，从 1 开始,示例值(1)querytrueint32
pageSize每页条数，最大值为 1000,示例值(10)querytrueint32
jobScheduleType任务调度类型；1：设备批量调用服务；2：设备批量设备属性；3：设备批量消息推送jsonfalsestring
createTime创建时间时间范围，示例值（2024-11-12 00:00:00 - 2024-11-29 23:59:59）queryfalsearray[datatime]
Authorization认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda)
获取access_token请参考获取访问令牌		headertruestring

响应状态

状态码说明
200OK

响应参数

参数名称参数说明数据类型
status状态码，值为0正常，其他值为异常int
code结果同status一样，冗余字段int
data创建成功返回产品Idobject
---total返回结果条数int
---list返回数据列表array
---id设备与任务idlong
------jobScheduleType任务调度类型；1：设备批量调用服务；2：设备批量设备属性；3：设备批量消息推送string
------jobTarget任务目标设备；设备id，多个任务目标请用逗号隔开string
------jobTargetRule任务目标规则string
------jobDesc任务描述string
------author负责人string
------alarmEmail邮箱通知string
------scheduleType调度类型；1：CRON；2：固定速度int
------scheduleConf调度配置；当scheduleType=1时，此值填cron表达式；当scheduleType=2时，此值填速度，单位为秒string
------misfireStrategy过期调度策略；DO_NOTHING：忽略；FIRE_ONCE_NOW：立即执行一次string
------executorTimeout任务执行超时时间，单位秒int
------executorFailRetryCount失败重试次数int
------triggerStatus调度状态，：1开启；0：停止int
msg状态消息string

响应示例

{
  "status": 0,
  "code": 0,
  "data": {
    "list": [
      {
        "id": 1420692966367232,
        "createTime": 1734244344000,
        "jobDesc": "开机设备与任务",
        "author": "小李子科技",
        "alarmEmail": "1720189720@qq.com",
        "scheduleType": "CRON",
        "scheduleConf": "3 * * * * ?",
        "misfireStrategy": "FIRE_ONCE_NOW",
        "executorTimeout": 10,
        "executorFailRetryCount": 2,
        "triggerStatus": 0,
        "triggerLastTime": 0,
        "triggerNextTime": 0,
        "jobScheduleType": 1,
        "jobTarget": "1420630729179136,1417640527249408",
        "jobTargetRule": "{\n  \"identifier\": \"power_on_service\",\n  \"inputParams\": {\n    \"params1\": 12,\n    \"params2\": 45\n  }\n}"
      }
    ],
    "total": 1
  },
  "msg": ""
}

删除设备与任务

DELETE/admin-api/iot/device-job-relation/delete

请求数据类型 ：application/json;charset=UTF-8

请求参数

参数名称参数说明请求类型是否必须数据类型
id要删除的设备与任务idjsontruelong
Authorization认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda)
获取access_token请参考获取访问令牌		headertruestring

响应状态

状态码说明
200OK

响应参数

参数名称参数说明数据类型
status状态码，值为0正常，其他值为异常int
code结果同status一样，冗余字段int
data删除成功返回trueboolean
msg状态消息string

响应示例

{
  "status": 0,
  "code": 0,
  "data": true,
  "msg": ""
}

更新设备与任务状态

PUT/admin-api/iot/device-job-relation/update-status

请求数据类型 ：application/json;charset=UTF-8

请求参数

参数名称参数说明请求类型是否必须数据类型
id要更新的设备与任务idjsontruelong
triggerStatus调度状态，：1开启；0：停止jsonfalseint
Authorization认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda)
获取access_token请参考获取访问令牌		headertruestring

响应状态

状态码说明
200OK

响应参数

参数名称参数说明数据类型
status状态码，值为0正常，其他值为异常int
code结果同status一样，冗余字段int
data更新成功返回trueboolean
msg状态消息string

响应示例

{
  "status": 0,
  "code": 0,
  "data": true,
  "msg": ""
}

获取任务与设备执行日志

GET/admin-api/iot/device-info/page

请求数据类型 ：application/json;charset=UTF-8

请求参数

参数名称参数说明请求类型是否必须数据类型
id要查询的设备与任务idjsontruelong
pageNo页码，从 1 开始,示例值(1)querytrueint32
pageSize每页条数，最大值为 1000,示例值(10)querytrueint32
logStatus任务执行状态；-1：全部；0：成功；1：失败；2：进行中jsonfalseint32
createTime创建时间时间范围，示例值（2024-11-12 00:00:00 - 2024-11-29 23:59:59）queryfalsearray[datatime]
Authorization认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda)
获取access_token请参考获取访问令牌		headertruestring

响应状态

状态码说明
200OK

响应参数

参数名称参数说明数据类型
status状态码，值为0正常，其他值为异常int
code结果同status一样，冗余字段int
data创建成功返回产品Idobject
---total返回结果条数int
---list返回数据列表array
------id历史idlong
------executorFailRetryCount执行错误重试次数string
------triggerCode错误代码；200：成功；其他：失败string
------triggerMsg执行结果string
------triggerTime执行时间，时间戳13位string
msg状态消息string

响应示例

{
  "status": 0,
  "code": 0,
  "data": {
    "list": [
      {
        "executorFailRetryCount": 2,
        "id": 2819,
        "triggerCode": 200,
        "triggerMsg": "任务触发类型：Cron触发<br>调度机器：192.168.230.1<br>执行器-注册方式：自动注册<br>执行器-地址列表：[http://192.168.230.1:9999/]<br>路由策略：第一个<br>阻塞处理策略：单机串行<br>任务超时时间：10<br>失败重试次数：2<br><br><span style=\"color:#00c0ef;\" > >>>>>>>>>>>触发调度<<<<<<<<<<< </span><br>触发调度：<br>address：http://192.168.230.1:9999/<br>code：200<br>msg：null",
        "triggerTime": 1734244623000
      },
      {
        "executorFailRetryCount": 0,
        "id": 2818,
        "triggerCode": 200,
        "triggerMsg": "任务触发类型：失败重试触发<br>调度机器：192.168.230.1<br>执行器-注册方式：自动注册<br>执行器-地址列表：[http://192.168.230.1:9999/]<br>路由策略：第一个<br>阻塞处理策略：单机串行<br>任务超时时间：10<br>失败重试次数：0<br><br><span style=\"color:#00c0ef;\" > >>>>>>>>>>>触发调度<<<<<<<<<<< </span><br>触发调度：<br>address：http://192.168.230.1:9999/<br>code：200<br>msg：null",
        "triggerTime": 1734244579000
      },
      {
        "executorFailRetryCount": 1,
        "id": 2817,
        "triggerCode": 500,
        "triggerMsg": "任务触发类型：失败重试触发<br>调度机器：192.168.230.1<br>执行器-注册方式：自动注册<br>执行器-地址列表：null<br>路由策略：第一个<br>阻塞处理策略：单机串行<br>任务超时时间：10<br>失败重试次数：1<br><br><span style=\"color:#00c0ef;\" > >>>>>>>>>>>触发调度<<<<<<<<<<< </span><br>调度失败：执行器地址为空<br><br><br><br><span style=\"color:#F39C12;\" > >>>>>>>>>>>失败重试触发<<<<<<<<<<< </span><br>",
        "triggerTime": 1734244564000
      },
      {
        "executorFailRetryCount": 2,
        "id": 2816,
        "triggerCode": 500,
        "triggerMsg": "任务触发类型：Cron触发<br>调度机器：192.168.230.1<br>执行器-注册方式：自动注册<br>执行器-地址列表：null<br>路由策略：第一个<br>阻塞处理策略：单机串行<br>任务超时时间：10<br>失败重试次数：2<br><br><span style=\"color:#00c0ef;\" > >>>>>>>>>>>触发调度<<<<<<<<<<< </span><br>调度失败：执行器地址为空<br><br><br><br><span style=\"color:#F39C12;\" > >>>>>>>>>>>失败重试触发<<<<<<<<<<< </span><br>",
        "triggerTime": 1734244563000
      },
      {
        "executorFailRetryCount": 0,
        "id": 2815,
        "triggerCode": 500,
        "triggerMsg": "任务触发类型：失败重试触发<br>调度机器：192.168.230.1<br>执行器-注册方式：自动注册<br>执行器-地址列表：null<br>路由策略：第一个<br>阻塞处理策略：单机串行<br>任务超时时间：10<br>失败重试次数：0<br><br><span style=\"color:#00c0ef;\" > >>>>>>>>>>>触发调度<<<<<<<<<<< </span><br>调度失败：执行器地址为空<br><br>",
        "triggerTime": 1734244523000
      },
      {
        "executorFailRetryCount": 1,
        "id": 2814,
        "triggerCode": 500,
        "triggerMsg": "任务触发类型：失败重试触发<br>调度机器：192.168.230.1<br>执行器-注册方式：自动注册<br>执行器-地址列表：[http://192.168.230.1:9999/]<br>路由策略：第一个<br>阻塞处理策略：单机串行<br>任务超时时间：10<br>失败重试次数：1<br><br><span style=\"color:#00c0ef;\" > >>>>>>>>>>>触发调度<<<<<<<<<<< </span><br>触发调度：<br>address：http://192.168.230.1:9999/<br>code：500<br>msg：xxl-job remoting error(Connection refused: connect), for url : http://192.168.230.1:9999/run<br><br><span style=\"color:#F39C12;\" > >>>>>>>>>>>失败重试触发<<<<<<<<<<< </span><br>",
        "triggerTime": 1734244508000
      },
      {
        "executorFailRetryCount": 2,
        "id": 2813,
        "triggerCode": 500,
        "triggerMsg": "任务触发类型：Cron触发<br>调度机器：192.168.230.1<br>执行器-注册方式：自动注册<br>执行器-地址列表：[http://192.168.230.1:9999/]<br>路由策略：第一个<br>阻塞处理策略：单机串行<br>任务超时时间：10<br>失败重试次数：2<br><br><span style=\"color:#00c0ef;\" > >>>>>>>>>>>触发调度<<<<<<<<<<< </span><br>触发调度：<br>address：http://192.168.230.1:9999/<br>code：500<br>msg：xxl-job remoting error(Connection refused: connect), for url : http://192.168.230.1:9999/run<br><br><span style=\"color:#F39C12;\" > >>>>>>>>>>>失败重试触发<<<<<<<<<<< </span><br>",
        "triggerTime": 1734244503000
      },
      {
        "executorFailRetryCount": 0,
        "id": 2812,
        "triggerCode": 500,
        "triggerMsg": "任务触发类型：失败重试触发<br>调度机器：192.168.230.1<br>执行器-注册方式：自动注册<br>执行器-地址列表：[http://192.168.230.1:9999/]<br>路由策略：第一个<br>阻塞处理策略：单机串行<br>任务超时时间：10<br>失败重试次数：0<br><br><span style=\"color:#00c0ef;\" > >>>>>>>>>>>触发调度<<<<<<<<<<< </span><br>触发调度：<br>address：http://192.168.230.1:9999/<br>code：500<br>msg：xxl-job remoting error(Connection refused: connect), for url : http://192.168.230.1:9999/run",
        "triggerTime": 1734244468000
      }
    ],
    "total": 10
  },
  "msg": ""
}
小李子科技