|
@@ -33,15 +33,13 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
|
|
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=snapshot-id]
|
|
|
+
|
|
|
--
|
|
|
-You can multiple snapshots for a single job in a single API request
|
|
|
-by using a comma-separated list of `<snapshot_id>` or a wildcard expression.
|
|
|
-You can get all snapshots for all calendars by using `_all`,
|
|
|
-by specifying `*` as the `<snapshot_id>`, or by omitting the `<snapshot_id>`.
|
|
|
+You can get information for multiple snapshots by using a comma-separated list
|
|
|
+or a wildcard expression. You can get all snapshots by using `_all`, by
|
|
|
+specifying `*` as the snapshot ID, or by omitting the snapshot ID.
|
|
|
--
|
|
|
|
|
|
-
|
|
|
-[[ml-get-snapshot-request-body]]
|
|
|
-== {api-request-body-title}
|
|
|
+[[ml-get-snapshot-query-parms]]
|
|
|
+== {api-query-parms-title}
|
|
|
|
|
|
`desc`::
|
|
|
(Optional, Boolean) If true, the results are sorted in descending order.
|
|
@@ -66,6 +64,19 @@ by specifying `*` as the `<snapshot_id>`, or by omitting the `<snapshot_id>`.
|
|
|
(Optional, string) Returns snapshots with timestamps after this time. Defaults
|
|
|
to unset, which means results are not limited to specific timestamps.
|
|
|
|
|
|
+[[ml-get-snapshot-request-body]]
|
|
|
+== {api-request-body-title}
|
|
|
+
|
|
|
+You can also specify the query parameters (such as `desc` and
|
|
|
+`end`) in the request body.
|
|
|
+
|
|
|
+`page`.`from`::
|
|
|
+(Optional, integer) Skips the specified number of snapshots. Defaults to `0`.
|
|
|
+
|
|
|
+`page`.`size`::
|
|
|
+(Optional, integer) Specifies the maximum number of snapshots to obtain.
|
|
|
+Defaults to `100`.
|
|
|
+
|
|
|
[role="child_attributes"]
|
|
|
[[ml-get-snapshot-results]]
|
|
|
== {api-response-body-title}
|
|
@@ -150,7 +161,7 @@ server-time.
|
|
|
Contains one of the following values.
|
|
|
+
|
|
|
--
|
|
|
-* `hard_limit`: The internal models require more space that the configured
|
|
|
+* `hard_limit`: The internal models require more space than the configured
|
|
|
memory limit. Some incoming data could not be processed.
|
|
|
* `ok`: The internal models stayed below the configured value.
|
|
|
* `soft_limit`: The internal models require more than 60% of the configured
|