Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Fixes ML get scheduled events API #78809

Merged
merged 1 commit into from
Oct 7, 2021
Merged

[DOCS] Fixes ML get scheduled events API #78809

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 42 additions & 6 deletions docs/reference/ml/anomaly-detection/apis/get-calendar-event.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ Requires the `monitor_ml` cluster privilege. This privilege is included in the

You can get scheduled event information for multiple calendars in a single
API request by using a comma-separated list of ids or a wildcard expression.
You can get scheduled event information for all calendars by using `_all`,
by specifying `*` as the `<calendar_id>`, or by omitting the `<calendar_id>`.
You can get scheduled event information for all calendars by using `_all` or `*`
as the `<calendar_id>`.

For more information, see
{ml-docs}/ml-ad-finding-anomalies.html#ml-ad-calendars[Calendars and scheduled events].
Expand All @@ -39,6 +39,28 @@ For more information, see
(Required, string)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=calendar-id]

[[ml-get-calendar-event-query-parms]]
== {api-query-parms-title}

`end`::
(Optional, string) Specifies to get events with timestamps earlier than this
time.

`from`::
(Optional, integer) Skips the specified number of events. Defaults to `0`.

`job_id`::
(Optional, string) Specifies to get events for a specific {anomaly-job}
identifier or job group. It must be used with a calendar identifier of `_all`
or `*`.

`size`::
(Optional, integer) Specifies the maximum number of events to obtain. Defaults
to `100`.

`start`::
(Optional, string) Specifies to get events with timestamps after this time.

[[ml-get-calendar-event-request-body]]
== {api-request-body-title}

Expand All @@ -47,17 +69,22 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=calendar-id]
time. Defaults to unset, which means results are not
limited to specific timestamps.

`from`::
`job_id`::
(Optional, string) Specifies to get events for a specific {anomaly-job}
identifier or job group. It must be used with a calendar identifier of `_all`
or `*`.

`page.from`::
(Optional, integer) Skips the specified number of events. Defaults to `0`.

`size`::
`page.size`::
(Optional, integer) Specifies the maximum number of events to obtain.
Defaults to `100`.

`start`::
(Optional, string) Specifies to get events with timestamps after this time.
Defaults to unset, which means results are not limited to
specific timestamps.
Defaults to unset, which means results are not limited to specific
timestamps.

[[ml-get-calendar-event-results]]
== {api-response-body-title}
Expand Down Expand Up @@ -126,3 +153,12 @@ The API returns the following results:
// TESTRESPONSE[s/LS8LJGEBMTCMA-qz49st/$body.$_path/]
// TESTRESPONSE[s/Li8LJGEBMTCMA-qz49st/$body.$_path/]
// TESTRESPONSE[s/Ly8LJGEBMTCMA-qz49st/$body.$_path/]

The following example retrieves scheduled events that occur within a specific
period of time:

[source,console]
--------------------------------------------------
GET _ml/*/planned-outages/events?start=1635638400000&end=1635724800000
--------------------------------------------------
// TEST[skip:setup:calendar_outages_addevent]