mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-03-09 14:34:43 +00:00
63 lines
1.4 KiB
Plaintext
63 lines
1.4 KiB
Plaintext
|
[role="xpack"]
|
||
|
|
[[ml-get-calendar]]
|
||
|
|
=== Get Calendars
|
||
|
|
|
||
|
|
The get calendars API enables you to retrieve configuration information for
|
||
|
|
calendars.
|
||
|
|
|
||
|
|
|
||
|
|
==== Request
|
||
|
|
|
||
|
|
`GET _xpack/ml/calendars/<calendar_id>` +
|
||
|
|
|
||
|
|
`GET _xpack/ml/calendars/<calendar_id>,<calendar_id>` +
|
||
|
|
|
||
|
|
`GET _xpack/ml/calendars/` +
|
||
|
|
|
||
|
|
`GET _xpack/ml/calendars/_all`
|
||
|
|
|
||
|
|
|
||
|
|
//===== Description
|
||
|
|
|
||
|
|
////
|
||
|
|
You can get information for multiple 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 jobs by using `_all`, by specifying `*` as the
|
||
|
|
`<job_id>`, or by omitting the `<job_id>`.
|
||
|
|
////
|
||
|
|
|
||
|
|
==== Path Parameters
|
||
|
|
|
||
|
|
`calendar_id`::
|
||
|
|
(string) Identifier for the calendar. It can be a calendar identifier or a
|
||
|
|
wildcard expression. If you do not specify one of these options, the API
|
||
|
|
returns information for all calendars.
|
||
|
|
|
||
|
|
|
||
|
|
==== Request Body
|
||
|
|
|
||
|
|
`from`:::
|
||
|
|
(integer) Skips the specified number of calendars.
|
||
|
|
|
||
|
|
`size`:::
|
||
|
|
(integer) Specifies the maximum number of calendars to obtain.
|
||
|
|
|
||
|
|
//==== Results
|
||
|
|
|
||
|
|
////
|
||
|
|
The API returns the following information:
|
||
|
|
|
||
|
|
`jobs`::
|
||
|
|
(array) An array of job resources.
|
||
|
|
For more information, see <<ml-job-resource,Job Resources>>.
|
||
|
|
////
|
||
|
|
|
||
|
|
==== Authorization
|
||
|
|
|
||
|
|
You must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster
|
||
|
|
privileges to use this API. For more information, see
|
||
|
|
{xpack-ref}/security-privileges.html[Security Privileges].
|
||
|
|
|
||
|
|
|
||
|
|
//==== Examples
|