start-job.asciidoc 1.6 KB

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