Files
elasticsearch-js/docs/reference-ml-get_jobs.asciidoc
2024-12-05 14:46:51 -06:00

76 lines
4.1 KiB
Plaintext

[[reference-ml-get_jobs]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
[discrete]
=== client.ml.getJobs
Get anomaly detection jobs configuration info. You can get information for multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can get information for all anomaly detection jobs by using `_all`, by specifying `*` as the `<job_id>`, or by omitting the `<job_id>`.
{ref}/ml-get-job.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(MlGetJobsRequest, options?): Promise<MlGetJobsResponse>
----
[discrete]
==== MlGetJobsRequest
[pass]
++++
<pre>
++++
interface MlGetJobsRequest extends <<RequestBase>> {
job_id?: <<Ids>>
allow_no_match?: boolean
exclude_generated?: boolean
}
[pass]
++++
</pre>
++++
[discrete]
==== MlGetJobsResponse
[pass]
++++
<pre>
++++
interface MlGetJobsResponse {
count: number
jobs: MlJob[]
}
[pass]
++++
</pre>
++++