get-calendar.asciidoc 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  1. [role="xpack"]
  2. [testenv="platinum"]
  3. [[ml-get-calendar]]
  4. === Get calendars API
  5. ++++
  6. <titleabbrev>Get calendars</titleabbrev>
  7. ++++
  8. Retrieves configuration information for calendars.
  9. [[ml-get-calendar-request]]
  10. ==== {api-request-title}
  11. `GET _ml/calendars/<calendar_id>` +
  12. `GET _ml/calendars/_all`
  13. [[ml-get-calendar-prereqs]]
  14. ==== {api-prereq-title}
  15. * If the {es} {security-features} are enabled, you must have `monitor_ml`,
  16. `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See
  17. {stack-ov}/security-privileges.html[Security privileges].
  18. [[ml-get-calendar-desc]]
  19. ==== {api-description-title}
  20. You can get information for a single calendar or for all calendars by using
  21. `_all`.
  22. For more information, see
  23. {stack-ov}/ml-calendars.html[Calendars and scheduled events].
  24. [[ml-get-calendar-path-parms]]
  25. ==== {api-path-parms-title}
  26. `<calendar_id>`::
  27. (Required, string) Identifier for the calendar.
  28. [[ml-get-calendar-request-body]]
  29. ==== {api-request-body-title}
  30. `page`::
  31. `from`:::
  32. (Optional, integer) Skips the specified number of calendars.
  33. `size`:::
  34. (Optional, integer) Specifies the maximum number of calendars to obtain.
  35. [[ml-get-calendar-results]]
  36. ==== {api-response-body-title}
  37. The API returns the following information:
  38. `calendars`::
  39. (array) An array of calendar resources. A calendar resource has the following
  40. properties:
  41. `calendar_id`:::
  42. (string) A numerical character string that uniquely identifies the calendar.
  43. `job_ids`:::
  44. (array) An array of job identifiers. For example: `["total-requests"]`.
  45. [[ml-get-calendar-example]]
  46. ==== {api-examples-title}
  47. The following example gets configuration information for the `planned-outages`
  48. calendar:
  49. [source,js]
  50. --------------------------------------------------
  51. GET _ml/calendars/planned-outages
  52. --------------------------------------------------
  53. // CONSOLE
  54. // TEST[skip:setup:calendar_outages_addjob]
  55. The API returns the following results:
  56. [source,js]
  57. ----
  58. {
  59. "count": 1,
  60. "calendars": [
  61. {
  62. "calendar_id": "planned-outages",
  63. "job_ids": [
  64. "total-requests"
  65. ]
  66. }
  67. ]
  68. }
  69. ----
  70. // TESTRESPONSE