diff --git a/docs/api.rst b/docs/api.rst index c4db0cbc..9baaa153 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -64,6 +64,117 @@ Add Job Directory curl -v -d "action=add&addpath=/Users/hstern/job" -k -u admin:admin --anyauth --location -H "Accept: application/xml" https://localhost:8443/engine +Get Job Status +~~~~~~~~~~~~~~ + +.. http:get:: https://(heritrixhost):8443/engine/job/(jobname) + + Returns status information and statistics about the chosen job. + + **XML Example:** + + .. code:: bash + + curl -v -k -u admin:admin --anyauth --location -H "Accept: application/xml" https://localhost:8443/engine/job/myjob + + Example output: + + .. code:: xml + + myjob + FINISHED + FINISHED + Finished: FINISHED + + teardown + + 1 + 2020-04-01T02:07:42.531Z + false + /heritrix/jobs/myjob/crawler-beans.cxml + https://localhost:8443/engine/job/myjob/jobdir/crawler-beans.cxml + https://localhost:8443/engine/job/myjob/job/myjob + + 2020-04-01T03:50:44.708Z INFO FINISHED 20200401020744 + 2020-04-01T03:50:42.670Z INFO EMPTY 20200401020744 + 2020-04-01T03:50:42.669Z INFO STOPPING 20200401020744 + + + 3920 + 0 + 3920 + 0 + + + 0 + 0 + 0 + 0 + 2177235508 + 3920 + 2177235508 + 3920 + 2177235508 + 3920 + + + 0.0 + 0.6354171124312226 + 0 + 344 + + + 0 + 0 + NaN + 0 + 0 + + + 6169176 + 1h42m49s176ms + + + + 1 + 0 + 0 + 0 + 0 + 0 + 0 + 0 + 1 + FINISH + + + ... + + + ... + + false + false + false + true + 549 + + /heritrix/jobs/myjob/20200401020744/logs/alerts.log + /heritrix/jobs/myjob/20200401020744/logs/crawl.log + + + CrawlSummaryReport + CrawlSummary + + ... + + + 66893400 + 589824000 + 2885681152 + + + Build Job Configuration ~~~~~~~~~~~~~~~~~~~~~~~