[关闭]
@soszrg 2018-12-06T02:07:09.000000Z 字数 11801 阅读 578

云端定时任务接口文档(philips)

philips


服务地址

版本

token说明

所有标明jwt认证的接口,需要在请求header中添加Authorization头域,值为:jwt token,如下示例:

  1. Authorization: jwt eyJhbGciOiJ...

ErrorCode说明

参数说明


创建定时任务(jwt认证)

POST /scheduler/task/

请求参数

参数名 类型 必须 说明
device_id string 设备ID
day_of_week string 定时任务执行周期
hour string 定时任务执行时间:小时
minute string 定时任务执行时间:分钟
commands json 执行指令
tz_area string 时区地区信息,默认为Asia/Shanghai

参数说明

day_of_week取值:

星期
0 周日
1 周一
2 周二
3 周三
4 周四
5 周五
6 周六
* 每天
0000000 仅执行一次

tz_area参考值

  1. Africa/Abidjan
  2. Africa/Accra
  3. Africa/Addis_Ababa
  4. Africa/Algiers
  5. Africa/Asmara
  6. Africa/Asmera
  7. Africa/Bamako
  8. Africa/Bangui
  9. Africa/Banjul
  10. Africa/Bissau
  11. Africa/Blantyre
  12. Africa/Brazzaville
  13. Africa/Bujumbura
  14. Africa/Cairo
  15. Africa/Casablanca
  16. Africa/Ceuta
  17. Africa/Conakry
  18. Africa/Dakar
  19. Africa/Dar_es_Salaam
  20. Africa/Djibouti
  21. Africa/Douala
  22. Africa/El_Aaiun
  23. Africa/Freetown
  24. Africa/Gaborone
  25. Africa/Harare
  26. Africa/Johannesburg
  27. Africa/Juba
  28. Africa/Kampala
  29. Africa/Khartoum
  30. Africa/Kigali
  31. Africa/Kinshasa
  32. Africa/Lagos
  33. Africa/Libreville
  34. Africa/Lome
  35. Africa/Luanda
  36. Africa/Lubumbashi
  37. Africa/Lusaka
  38. Africa/Malabo
  39. Africa/Maputo
  40. Africa/Maseru
  41. Africa/Mbabane
  42. Africa/Mogadishu
  43. Africa/Monrovia
  44. Africa/Nairobi
  45. Africa/Ndjamena
  46. Africa/Niamey
  47. Africa/Nouakchott
  48. Africa/Ouagadougou
  49. Africa/Porto-Novo
  50. Africa/Sao_Tome
  51. Africa/Timbuktu
  52. Africa/Tripoli
  53. Africa/Tunis
  54. Africa/Windhoek
  55. America/Adak
  56. America/Anchorage
  57. America/Anguilla
  58. America/Antigua
  59. America/Araguaina
  60. America/Argentina/Buenos_Aires
  61. America/Argentina/Catamarca
  62. America/Argentina/ComodRivadavia
  63. America/Argentina/Cordoba
  64. America/Argentina/Jujuy
  65. America/Argentina/La_Rioja
  66. America/Argentina/Mendoza
  67. America/Argentina/Rio_Gallegos
  68. America/Argentina/Salta
  69. America/Argentina/San_Juan
  70. America/Argentina/San_Luis
  71. America/Argentina/Tucuman
  72. America/Argentina/Ushuaia
  73. America/Aruba
  74. America/Asuncion
  75. America/Atikokan
  76. America/Atka
  77. America/Bahia
  78. America/Bahia_Banderas
  79. America/Barbados
  80. America/Belem
  81. America/Belize
  82. America/Blanc-Sablon
  83. America/Boa_Vista
  84. America/Bogota
  85. America/Boise
  86. America/Buenos_Aires
  87. America/Cambridge_Bay
  88. America/Campo_Grande
  89. America/Cancun
  90. America/Caracas
  91. America/Catamarca
  92. America/Cayenne
  93. America/Cayman
  94. America/Chicago
  95. America/Chihuahua
  96. America/Coral_Harbour
  97. America/Cordoba
  98. America/Costa_Rica
  99. America/Creston
  100. America/Cuiaba
  101. America/Curacao
  102. America/Danmarkshavn
  103. America/Dawson
  104. America/Dawson_Creek
  105. America/Denver
  106. America/Detroit
  107. America/Dominica
  108. America/Edmonton
  109. America/Eirunepe
  110. America/El_Salvador
  111. America/Ensenada
  112. America/Fort_Nelson
  113. America/Fort_Wayne
  114. America/Fortaleza
  115. America/Glace_Bay
  116. America/Godthab
  117. America/Goose_Bay
  118. America/Grand_Turk
  119. America/Grenada
  120. America/Guadeloupe
  121. America/Guatemala
  122. America/Guayaquil
  123. America/Guyana
  124. America/Halifax
  125. America/Havana
  126. America/Hermosillo
  127. America/Indiana/Indianapolis
  128. America/Indiana/Knox
  129. America/Indiana/Marengo
  130. America/Indiana/Petersburg
  131. America/Indiana/Tell_City
  132. America/Indiana/Vevay
  133. America/Indiana/Vincennes
  134. America/Indiana/Winamac
  135. America/Indianapolis
  136. America/Inuvik
  137. America/Iqaluit
  138. America/Jamaica
  139. America/Jujuy
  140. America/Juneau
  141. America/Kentucky/Louisville
  142. America/Kentucky/Monticello
  143. America/Knox_IN
  144. America/Kralendijk
  145. America/La_Paz
  146. America/Lima
  147. America/Los_Angeles
  148. America/Louisville
  149. America/Lower_Princes
  150. America/Maceio
  151. America/Managua
  152. America/Manaus
  153. America/Marigot
  154. America/Martinique
  155. America/Matamoros
  156. America/Mazatlan
  157. America/Mendoza
  158. America/Menominee
  159. America/Merida
  160. America/Metlakatla
  161. America/Mexico_City
  162. America/Miquelon
  163. America/Moncton
  164. America/Monterrey
  165. America/Montevideo
  166. America/Montreal
  167. America/Montserrat
  168. America/Nassau
  169. America/New_York
  170. America/Nipigon
  171. America/Nome
  172. America/Noronha
  173. America/North_Dakota/Beulah
  174. America/North_Dakota/Center
  175. America/North_Dakota/New_Salem
  176. America/Ojinaga
  177. America/Panama
  178. America/Pangnirtung
  179. America/Paramaribo
  180. America/Phoenix
  181. America/Port-au-Prince
  182. America/Port_of_Spain
  183. America/Porto_Acre
  184. America/Porto_Velho
  185. America/Puerto_Rico
  186. America/Punta_Arenas
  187. America/Rainy_River
  188. America/Rankin_Inlet
  189. America/Recife
  190. America/Regina
  191. America/Resolute
  192. America/Rio_Branco
  193. America/Rosario
  194. America/Santa_Isabel
  195. America/Santarem
  196. America/Santiago
  197. America/Santo_Domingo
  198. America/Sao_Paulo
  199. America/Scoresbysund
  200. America/Shiprock
  201. America/Sitka
  202. America/St_Barthelemy
  203. America/St_Johns
  204. America/St_Kitts
  205. America/St_Lucia
  206. America/St_Thomas
  207. America/St_Vincent
  208. America/Swift_Current
  209. America/Tegucigalpa
  210. America/Thule
  211. America/Thunder_Bay
  212. America/Tijuana
  213. America/Toronto
  214. America/Tortola
  215. America/Vancouver
  216. America/Virgin
  217. America/Whitehorse
  218. America/Winnipeg
  219. America/Yakutat
  220. America/Yellowknife
  221. Antarctica/Casey
  222. Antarctica/Davis
  223. Antarctica/DumontDUrville
  224. Antarctica/Macquarie
  225. Antarctica/Mawson
  226. Antarctica/McMurdo
  227. Antarctica/Palmer
  228. Antarctica/Rothera
  229. Antarctica/South_Pole
  230. Antarctica/Syowa
  231. Antarctica/Troll
  232. Antarctica/Vostok
  233. Arctic/Longyearbyen
  234. Asia/Aden
  235. Asia/Almaty
  236. Asia/Amman
  237. Asia/Anadyr
  238. Asia/Aqtau
  239. Asia/Aqtobe
  240. Asia/Ashgabat
  241. Asia/Ashkhabad
  242. Asia/Atyrau
  243. Asia/Baghdad
  244. Asia/Bahrain
  245. Asia/Baku
  246. Asia/Bangkok
  247. Asia/Barnaul
  248. Asia/Beirut
  249. Asia/Bishkek
  250. Asia/Brunei
  251. Asia/Calcutta
  252. Asia/Chita
  253. Asia/Choibalsan
  254. Asia/Chongqing
  255. Asia/Chungking
  256. Asia/Colombo
  257. Asia/Dacca
  258. Asia/Damascus
  259. Asia/Dhaka
  260. Asia/Dili
  261. Asia/Dubai
  262. Asia/Dushanbe
  263. Asia/Famagusta
  264. Asia/Gaza
  265. Asia/Harbin
  266. Asia/Hebron
  267. Asia/Ho_Chi_Minh
  268. Asia/Hong_Kong
  269. Asia/Hovd
  270. Asia/Irkutsk
  271. Asia/Istanbul
  272. Asia/Jakarta
  273. Asia/Jayapura
  274. Asia/Jerusalem
  275. Asia/Kabul
  276. Asia/Kamchatka
  277. Asia/Karachi
  278. Asia/Kashgar
  279. Asia/Kathmandu
  280. Asia/Katmandu
  281. Asia/Khandyga
  282. Asia/Kolkata
  283. Asia/Krasnoyarsk
  284. Asia/Kuala_Lumpur
  285. Asia/Kuching
  286. Asia/Kuwait
  287. Asia/Macao
  288. Asia/Macau
  289. Asia/Magadan
  290. Asia/Makassar
  291. Asia/Manila
  292. Asia/Muscat
  293. Asia/Nicosia
  294. Asia/Novokuznetsk
  295. Asia/Novosibirsk
  296. Asia/Omsk
  297. Asia/Oral
  298. Asia/Phnom_Penh
  299. Asia/Pontianak
  300. Asia/Pyongyang
  301. Asia/Qatar
  302. Asia/Qyzylorda
  303. Asia/Rangoon
  304. Asia/Riyadh
  305. Asia/Saigon
  306. Asia/Sakhalin
  307. Asia/Samarkand
  308. Asia/Seoul
  309. Asia/Shanghai
  310. Asia/Singapore
  311. Asia/Srednekolymsk
  312. Asia/Taipei
  313. Asia/Tashkent
  314. Asia/Tbilisi
  315. Asia/Tehran
  316. Asia/Tel_Aviv
  317. Asia/Thimbu
  318. Asia/Thimphu
  319. Asia/Tokyo
  320. Asia/Tomsk
  321. Asia/Ujung_Pandang
  322. Asia/Ulaanbaatar
  323. Asia/Ulan_Bator
  324. Asia/Urumqi
  325. Asia/Ust-Nera
  326. Asia/Vientiane
  327. Asia/Vladivostok
  328. Asia/Yakutsk
  329. Asia/Yangon
  330. Asia/Yekaterinburg
  331. Asia/Yerevan
  332. Atlantic/Azores
  333. Atlantic/Bermuda
  334. Atlantic/Canary
  335. Atlantic/Cape_Verde
  336. Atlantic/Faeroe
  337. Atlantic/Faroe
  338. Atlantic/Jan_Mayen
  339. Atlantic/Madeira
  340. Atlantic/Reykjavik
  341. Atlantic/South_Georgia
  342. Atlantic/St_Helena
  343. Atlantic/Stanley
  344. Australia/ACT
  345. Australia/Adelaide
  346. Australia/Brisbane
  347. Australia/Broken_Hill
  348. Australia/Canberra
  349. Australia/Currie
  350. Australia/Darwin
  351. Australia/Eucla
  352. Australia/Hobart
  353. Australia/LHI
  354. Australia/Lindeman
  355. Australia/Lord_Howe
  356. Australia/Melbourne
  357. Australia/NSW
  358. Australia/North
  359. Australia/Perth
  360. Australia/Queensland
  361. Australia/South
  362. Australia/Sydney
  363. Australia/Tasmania
  364. Australia/Victoria
  365. Australia/West
  366. Australia/Yancowinna
  367. Brazil/Acre
  368. Brazil/DeNoronha
  369. Brazil/East
  370. Brazil/West
  371. CET
  372. CST6CDT
  373. Canada/Atlantic
  374. Canada/Central
  375. Canada/Eastern
  376. Canada/Mountain
  377. Canada/Newfoundland
  378. Canada/Pacific
  379. Canada/Saskatchewan
  380. Canada/Yukon
  381. Chile/Continental
  382. Chile/EasterIsland
  383. Cuba
  384. EET
  385. EST
  386. EST5EDT
  387. Egypt
  388. Eire
  389. Etc/GMT
  390. Etc/GMT+0
  391. Etc/GMT+1
  392. Etc/GMT+10
  393. Etc/GMT+11
  394. Etc/GMT+12
  395. Etc/GMT+2
  396. Etc/GMT+3
  397. Etc/GMT+4
  398. Etc/GMT+5
  399. Etc/GMT+6
  400. Etc/GMT+7
  401. Etc/GMT+8
  402. Etc/GMT+9
  403. Etc/GMT-0
  404. Etc/GMT-1
  405. Etc/GMT-10
  406. Etc/GMT-11
  407. Etc/GMT-12
  408. Etc/GMT-13
  409. Etc/GMT-14
  410. Etc/GMT-2
  411. Etc/GMT-3
  412. Etc/GMT-4
  413. Etc/GMT-5
  414. Etc/GMT-6
  415. Etc/GMT-7
  416. Etc/GMT-8
  417. Etc/GMT-9
  418. Etc/GMT0
  419. Etc/Greenwich
  420. Etc/UCT
  421. Etc/UTC
  422. Etc/Universal
  423. Etc/Zulu
  424. Europe/Amsterdam
  425. Europe/Andorra
  426. Europe/Astrakhan
  427. Europe/Athens
  428. Europe/Belfast
  429. Europe/Belgrade
  430. Europe/Berlin
  431. Europe/Bratislava
  432. Europe/Brussels
  433. Europe/Bucharest
  434. Europe/Budapest
  435. Europe/Busingen
  436. Europe/Chisinau
  437. Europe/Copenhagen
  438. Europe/Dublin
  439. Europe/Gibraltar
  440. Europe/Guernsey
  441. Europe/Helsinki
  442. Europe/Isle_of_Man
  443. Europe/Istanbul
  444. Europe/Jersey
  445. Europe/Kaliningrad
  446. Europe/Kiev
  447. Europe/Kirov
  448. Europe/Lisbon
  449. Europe/Ljubljana
  450. Europe/London
  451. Europe/Luxembourg
  452. Europe/Madrid
  453. Europe/Malta
  454. Europe/Mariehamn
  455. Europe/Minsk
  456. Europe/Monaco
  457. Europe/Moscow
  458. Europe/Nicosia
  459. Europe/Oslo
  460. Europe/Paris
  461. Europe/Podgorica
  462. Europe/Prague
  463. Europe/Riga
  464. Europe/Rome
  465. Europe/Samara
  466. Europe/San_Marino
  467. Europe/Sarajevo
  468. Europe/Saratov
  469. Europe/Simferopol
  470. Europe/Skopje
  471. Europe/Sofia
  472. Europe/Stockholm
  473. Europe/Tallinn
  474. Europe/Tirane
  475. Europe/Tiraspol
  476. Europe/Ulyanovsk
  477. Europe/Uzhgorod
  478. Europe/Vaduz
  479. Europe/Vatican
  480. Europe/Vienna
  481. Europe/Vilnius
  482. Europe/Volgograd
  483. Europe/Warsaw
  484. Europe/Zagreb
  485. Europe/Zaporozhye
  486. Europe/Zurich
  487. GB
  488. GB-Eire
  489. GMT
  490. GMT+0
  491. GMT-0
  492. GMT0
  493. Greenwich
  494. HST
  495. Hongkong
  496. Iceland
  497. Indian/Antananarivo
  498. Indian/Chagos
  499. Indian/Christmas
  500. Indian/Cocos
  501. Indian/Comoro
  502. Indian/Kerguelen
  503. Indian/Mahe
  504. Indian/Maldives
  505. Indian/Mauritius
  506. Indian/Mayotte
  507. Indian/Reunion
  508. Iran
  509. Israel
  510. Jamaica
  511. Japan
  512. Kwajalein
  513. Libya
  514. MET
  515. MST
  516. MST7MDT
  517. Mexico/BajaNorte
  518. Mexico/BajaSur
  519. Mexico/General
  520. NZ
  521. NZ-CHAT
  522. Navajo
  523. PRC
  524. PST8PDT
  525. Pacific/Apia
  526. Pacific/Auckland
  527. Pacific/Bougainville
  528. Pacific/Chatham
  529. Pacific/Chuuk
  530. Pacific/Easter
  531. Pacific/Efate
  532. Pacific/Enderbury
  533. Pacific/Fakaofo
  534. Pacific/Fiji
  535. Pacific/Funafuti
  536. Pacific/Galapagos
  537. Pacific/Gambier
  538. Pacific/Guadalcanal
  539. Pacific/Guam
  540. Pacific/Honolulu
  541. Pacific/Johnston
  542. Pacific/Kiritimati
  543. Pacific/Kosrae
  544. Pacific/Kwajalein
  545. Pacific/Majuro
  546. Pacific/Marquesas
  547. Pacific/Midway
  548. Pacific/Nauru
  549. Pacific/Niue
  550. Pacific/Norfolk
  551. Pacific/Noumea
  552. Pacific/Pago_Pago
  553. Pacific/Palau
  554. Pacific/Pitcairn
  555. Pacific/Pohnpei
  556. Pacific/Ponape
  557. Pacific/Port_Moresby
  558. Pacific/Rarotonga
  559. Pacific/Saipan
  560. Pacific/Samoa
  561. Pacific/Tahiti
  562. Pacific/Tarawa
  563. Pacific/Tongatapu
  564. Pacific/Truk
  565. Pacific/Wake
  566. Pacific/Wallis
  567. Pacific/Yap
  568. Poland
  569. Portugal
  570. ROC
  571. ROK
  572. Singapore
  573. Turkey
  574. UCT
  575. US/Alaska
  576. US/Aleutian
  577. US/Arizona
  578. US/Central
  579. US/East-Indiana
  580. US/Eastern
  581. US/Hawaii
  582. US/Indiana-Starke
  583. US/Michigan
  584. US/Mountain
  585. US/Pacific
  586. US/Samoa
  587. UTC
  588. Universal
  589. W-SU
  590. WET
  591. Zulu

定时任务示例

  1. {
  2. "device_id":"7c1544595...",
  3. "day_of_week":"1,3,5",
  4. "tz_area": "Asia/Shanghai",
  5. "hour":"19",
  6. "minute":"15",
  7. "commands":{
  8. "state": {
  9. "desired": {
  10. "EndUserID":"aaabbbcccddd...",
  11. "DeviceId":"c14fe8c88be...",
  12. "Switch": "1",
  13. "CommandType":"scheduler"
  14. }
  15. }
  16. }
  17. }

返回值

  1. {
  2. "data": {
  3. "create_time": "2018-08-02 22:08:35",
  4. "day_of_week": "1,3,5",
  5. "device_id": "ecdacbfa...",
  6. "enabled": 1,
  7. "enduser_id": "90b4b35c....",
  8. "hour": "19",
  9. "tz_area": "Asia/Shanghai",
  10. "commands": {
  11. "state": {
  12. "desired": {
  13. "EndUserID":"aaabbbcccddd...",
  14. "DeviceId":"c14fe8c88be...",
  15. "Switch": "1",
  16. "CommandType":"scheduler"
  17. }
  18. }
  19. },
  20. "minute": "15",
  21. "name": "40938bab966411e...",
  22. "update_time": "2018-08-02 22:08:35"
  23. },
  24. "meta": {
  25. "code": 0,
  26. "message": "create task ok."
  27. }
  28. }

字段说明

字段 类型 说明
name string 任务ID(唯一ID)用于更新,获取和删除任务
enabled int 任务是否开启:1→开启;0→关闭
update_time string 更新时间
create_time string 创建时间

错误码

错误码 说明
10000 参数错误:参考Response的message字段
10350 用户与设备间没有绑定关系

获取定时任务(jwt认证)

GET /scheduler/task/<name>/

请求参数

参数名 类型 必须 说明
name string 任务ID(拼接到url中)

返回值

  1. {
  2. "data": {
  3. "commands": {
  4. "switch": 1
  5. },
  6. "create_time": "2018-08-02 23:08:48",
  7. "day_of_week": "2,3",
  8. "device_id": "ecdacbfa962811e...",
  9. "enabled": 0,
  10. "enduser_id": "90b4b35c96271...",
  11. "hour": "15",
  12. "minute": "11",
  13. "name": "d6da14dc966...",
  14. "tz_area": "Asia/Shanghai",
  15. "update_time": "2018-08-02 23:08:09"
  16. },
  17. "meta": {
  18. "code": 0,
  19. "message": "task info"
  20. }
  21. }

错误码

错误码 说明
10000 参数错误:参考Response的message字段

更新定时任务(jwt认证)

PUT /scheduler/task/<name>/

请求参数

参数名 类型 必须 说明
name string 任务ID(拼接到url中)
day_of_week string 定时任务执行周期
enabled int 任务的开启状态
hour string 定时任务执行时间:小时
minute string 定时任务执行时间:分钟
commands json 执行指令
tz_area string 时区对应地区,默认为上次记录的地区

更新定时任务示例

  1. {
  2. "day_of_week":"1,3,5",
  3. "enabled": 1
  4. "tz_area": "Asia/Shanghai",
  5. "hour":"20",
  6. "minute":"15",
  7. "commands":{"switch":1}
  8. }

返回值

  1. {
  2. "data": {
  3. "commands": {
  4. "switch": 1
  5. },
  6. "create_time": "2018-08-02 23:08:48",
  7. "day_of_week": "1,3,5",
  8. "device_id": "ecdacbfa9...",
  9. "enabled": 0,
  10. "enduser_id": "90b4b35c96",
  11. "hour": "20",
  12. "minute": "15",
  13. "name": "d6da14dc966...",
  14. "tz_area": "Asia/Shanghai",
  15. "update_time": "2018-08-02 23:08:08"
  16. },
  17. "meta": {
  18. "code": 0,
  19. "message": "update task ok."
  20. }
  21. }

错误码

错误码 说明
10000 参数错误:参考Response的message字段

删除定时任务(jwt认证)

DELETE /schedulerr/task/<name>/

请求参数

参数名 类型 必须 说明
name string 任务ID(拼接到url中)

返回值

  1. {
  2. "data": {},
  3. "meta": {
  4. "code": 0,
  5. "message": "delete[d6da14dc...] ok"
  6. }
  7. }

错误码

错误码 说明
10000 参数错误:参考Response的message字段

获取定时任务列表(jwt认证)

GET /scheduler/tasks/

请求参数

参数名 类型 必须 说明
device_id string 设备ID

返回值

  1. {
  2. "data": [
  3. {
  4. "commands": {
  5. "switch": 1
  6. },
  7. "create_time": "2018-08-02 23:08:57",
  8. "day_of_week": "2,3",
  9. "device_id": "ecdacbfa96...",
  10. "enabled": 1,
  11. "enduser_id": "90b4b35c96...",
  12. "hour": "15",
  13. "minute": "11",
  14. "tz_area": "Asia/Shanghai",
  15. "name": "1e19f563966611...",
  16. "update_time": "2018-08-02 23:08:57"
  17. },
  18. {
  19. "commands": {
  20. "switch": 1
  21. },
  22. "create_time": "2018-08-02 23:08:45",
  23. "day_of_week": "2,3",
  24. "device_id": "ecdacbf...",
  25. "enabled": 1,
  26. "tz_area": "Asia/Shanghai",
  27. "enduser_id": "90b4b35c96...",
  28. "hour": "15",
  29. "minute": "11",
  30. "name": "176ae123966...",
  31. "update_time": "2018-08-02 23:08:45"
  32. }
  33. ],
  34. "meta": {
  35. "code": 0,
  36. "message": "tasks info"
  37. }
  38. }

错误码

错误码 说明
10000 参数错误:参考Response的message字段

添加新批注
在作者公开此批注前,只有你和作者可见。
回复批注