【智能模式】【流程圖模式】如何使用API接口
摘要:本篇教程主要介紹了后羿采集器中API接口的使用方法。 免費下載軟件
通過使用后羿采集器的API接口功能,您可以通過發送HTTP請求來控制采集任務。
可以支持的功能包括:獲取任務列表、獲取任務狀態、啟動任務、停止任務、刪除任務、復制任務和清空任務數據。
API接口在軟件的設置中心啟動,如下圖所示:
后羿采集器默認監聽端口為80,您可以在設置中進行更改。API服務器綁定運行后羿采集器的終端的所有IP。
例如:假設您的終端的IP是10.0.0.1,端口是80,那么RESTful API的基本URL是http://10.0.0.1:80/
。
后羿采集器的API接口支持get和post兩種請求方式,具體方式如下:
(1)獲取采集任務列表
接口路徑:
/rest/v1/task/list
參數:
無
返回示例:
{ "code": 0, // 接口返回的狀態碼(0表示請求成功,-1表示請求失敗) "msg": "請求列表成功", // 接口返回的成功或失敗信息 "list": [ { "name": "采集任務名稱", // 采集任務的名稱 "time_create": 1556000668, // 創建采集任務的時間戳 "task_id": "5122057", // 采集任務的id "type": "smart" // smart表示智能模式,flowchart表示流程圖模式 } ] }
(2)獲取采集任務狀態
接口路徑:
/rest/v1/task/<采集任務id>/status
參數:
無
返回示例:
{ "code": 0, "msg": "獲取采集任務狀態成功", "status": "SLEEPING", "status_change_time":?"1644492503" // 采集任務最近一次停止或休息的時間戳 }
(3)刪除采集任務
接口路徑:
/rest/v1/task/<采集任務id>/delete
參數:
無
返回示例:
{ "code": 0, "msg": "刪除采集任務成功" }
(4)啟動采集任務
接口路徑:
/rest/v1/task/<采集任務id>/start
參數:
無
返回示例:
{ "code": 0, "msg": "采集任務啟動成功" }
(5)停止采集任務
接口路徑:
/rest/v1/task/<采集任務id>/stop
參數:
無
返回示例:
{ "code": 0, "msg": "采集任務停止成功" }
(6)復制爬蟲任務
接口路徑:
/rest/v1/task/<采集任務id>/copy
參數:
參數 | 參數說明 |
name | 復制后的采集任務名稱,默認原文件名+ “-copy”,可選 |
translate_chart | 復制的采集任務是否轉為流程圖模式,默認false,可選 |
返回示例:
{ "code": 0, "msg": "采集任務復制成功" }
(7)清空采集任務數據
接口路徑:
/rest/v1/task/<采集任務id>/data/clear
參數:
無
返回示例:
{ "code": 0, "msg": "清空采集任務數據成功" }