rollup-apis.asciidoc 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  1. [role="xpack"]
  2. [testenv="basic"]
  3. [[rollup-apis]]
  4. == Rollup APIs
  5. ifdef::permanently-unreleased-branch[]
  6. A rollup aggregates an index's time-series data and stores the results in
  7. another index, called a rollup index. For example, you can roll up hourly data
  8. into daily or weekly summaries.
  9. * <<rollup-api,Rollup API>>
  10. [discrete]
  11. [[legacy-rollup-apis]]
  12. === Legacy rollup APIs
  13. Prior to {es} 7.x, you could only create rollups using periodic cron jobs.
  14. Special APIs were required to manage the jobs and search the resulting rollup
  15. indices. These rollup APIs are now deprecated and will be removed in a future
  16. release.
  17. [discrete]
  18. [[rollup-jobs-endpoint]]
  19. ==== Jobs
  20. * <<rollup-put-job,Create>> or <<rollup-delete-job,delete {rollup-jobs}>>
  21. * <<rollup-start-job,Start>> or <<rollup-stop-job,stop {rollup-jobs}>>
  22. * <<rollup-get-job,Get {rollup-jobs}>>
  23. [discrete]
  24. [[rollup-data-endpoint]]
  25. ==== Data
  26. * <<rollup-get-rollup-caps,Get rollup capabilities>>
  27. * <<rollup-get-rollup-index-caps,Get rollup index capabilities>>
  28. [discrete]
  29. [[rollup-search-endpoint]]
  30. ==== Search
  31. * <<rollup-search,Rollup search>>
  32. include::apis/rollup-api.asciidoc[]
  33. include::apis/put-job.asciidoc[]
  34. include::apis/delete-job.asciidoc[]
  35. include::apis/get-job.asciidoc[]
  36. include::apis/rollup-caps.asciidoc[]
  37. include::apis/rollup-index-caps.asciidoc[]
  38. include::apis/rollup-search.asciidoc[]
  39. include::apis/start-job.asciidoc[]
  40. include::apis/stop-job.asciidoc[]
  41. endif::[]
  42. ifndef::permanently-unreleased-branch[]
  43. [discrete]
  44. [[rollup-jobs-endpoint]]
  45. === Jobs
  46. * <<rollup-put-job,Create>> or <<rollup-delete-job,delete {rollup-jobs}>>
  47. * <<rollup-start-job,Start>> or <<rollup-stop-job,stop {rollup-jobs}>>
  48. * <<rollup-get-job,Get {rollup-jobs}>>
  49. [discrete]
  50. [[rollup-data-endpoint]]
  51. === Data
  52. * <<rollup-get-rollup-caps,Get rollup capabilities>>
  53. * <<rollup-get-rollup-index-caps,Get rollup index capabilities>>
  54. [discrete]
  55. [[rollup-search-endpoint]]
  56. === Search
  57. * <<rollup-search,Rollup search>>
  58. include::apis/put-job.asciidoc[]
  59. include::apis/delete-job.asciidoc[]
  60. include::apis/get-job.asciidoc[]
  61. include::apis/rollup-caps.asciidoc[]
  62. include::apis/rollup-index-caps.asciidoc[]
  63. include::apis/rollup-search.asciidoc[]
  64. include::apis/start-job.asciidoc[]
  65. include::apis/stop-job.asciidoc[]
  66. endif::[]