start-job.asciidoc 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. [role="xpack"]
  2. [testenv="basic"]
  3. [[rollup-start-job]]
  4. === Start {rollup-jobs} API
  5. [subs="attributes"]
  6. ++++
  7. <titleabbrev>Start {rollup-jobs}</titleabbrev>
  8. ++++
  9. Starts an existing, stopped {rollup-job}.
  10. experimental[]
  11. [[rollup-start-job-request]]
  12. ==== {api-request-title}
  13. `POST _rollup/job/<job_id>/_start`
  14. [[rollup-start-job-prereqs]]
  15. ==== {api-prereq-title}
  16. * If the {es} {security-features} are enabled, you must have `manage` or
  17. `manage_rollup` cluster privileges to use this API. For more information, see
  18. <<security-privileges>>.
  19. [[rollup-start-job-desc]]
  20. ==== {api-description-title}
  21. If you try to start a job that does not exist, an exception occurs. If you try
  22. to start a job that is already started, nothing happens.
  23. [[rollup-start-job-path-params]]
  24. ==== {api-path-parms-title}
  25. `<job_id>`::
  26. (Required, string) Identifier for the {rollup-job}.
  27. [[rollup-start-job-response-codes]]
  28. ==== {api-response-codes-title}
  29. `404` (Missing resources)::
  30. This code indicates that there are no resources that match the request. It
  31. occurs if you try to start a job that doesn't exist.
  32. [[rollup-start-job-examples]]
  33. ==== {api-examples-title}
  34. If we have already created a {rollup-job} named `sensor`, it can be started with:
  35. [source,console]
  36. --------------------------------------------------
  37. POST _rollup/job/sensor/_start
  38. --------------------------------------------------
  39. // TEST[setup:sensor_rollup_job]
  40. Which will return the response:
  41. [source,console-result]
  42. ----
  43. {
  44. "started": true
  45. }
  46. ----