2017-06-28 08:16:51 +08:00
|
|
|
[role="xpack"]
|
2017-03-30 00:07:55 +08:00
|
|
|
[[watcher-api-start]]
|
2019-09-05 08:03:05 +08:00
|
|
|
=== Start watch service API
|
2018-12-21 02:23:28 +08:00
|
|
|
++++
|
2019-09-05 08:03:05 +08:00
|
|
|
<titleabbrev>Start watch service</titleabbrev>
|
2018-12-21 02:23:28 +08:00
|
|
|
++++
|
2017-03-30 00:07:55 +08:00
|
|
|
|
2025-01-01 04:02:59 +08:00
|
|
|
.New API reference
|
|
|
|
|
[sidebar]
|
|
|
|
|
--
|
|
|
|
|
For the most up-to-date API details, refer to {api-es}/group/endpoint-watcher[{watcher} APIs].
|
|
|
|
|
--
|
|
|
|
|
|
2019-09-05 08:03:05 +08:00
|
|
|
Starts the {watcher} service if it is not already running.
|
2017-09-15 04:01:47 +08:00
|
|
|
|
2019-09-06 02:19:35 +08:00
|
|
|
[[watcher-api-start-request]]
|
|
|
|
|
==== {api-request-title}
|
2017-09-15 04:01:47 +08:00
|
|
|
|
2018-12-09 02:57:16 +08:00
|
|
|
`POST _watcher/_start`
|
2017-09-15 04:01:47 +08:00
|
|
|
|
2019-09-06 02:19:35 +08:00
|
|
|
[[watcher-api-start-prereqs]]
|
|
|
|
|
==== {api-prereq-title}
|
2017-09-15 04:01:47 +08:00
|
|
|
|
2019-09-06 02:19:35 +08:00
|
|
|
* You must have `manage_watcher` cluster privileges to use this API. For more
|
2019-10-05 07:10:26 +08:00
|
|
|
information, see <<security-privileges>>.
|
2017-09-15 04:01:47 +08:00
|
|
|
|
2019-09-06 02:19:35 +08:00
|
|
|
//[[watcher-api-start-desc]]
|
|
|
|
|
//==== {api-description-title}
|
|
|
|
|
|
|
|
|
|
//[[watcher-api-start-path-params]]
|
|
|
|
|
//==== {api-path-parms-title}
|
|
|
|
|
|
2024-05-16 11:05:39 +08:00
|
|
|
//[[watcher-api-start-query-params]]
|
|
|
|
|
//==== {api-query-parms-title}
|
2019-09-06 02:19:35 +08:00
|
|
|
|
|
|
|
|
//[[watcher-api-start-request-body]]
|
|
|
|
|
//==== {api-request-body-title}
|
|
|
|
|
|
|
|
|
|
//[[watcher-api-start-response-body]]
|
|
|
|
|
//==== {api-response-body-title}
|
|
|
|
|
|
|
|
|
|
//[[watcher-api-start-response-codes]]
|
|
|
|
|
//==== {api-response-codes-title}
|
|
|
|
|
|
|
|
|
|
[[watcher-api-start-example]]
|
|
|
|
|
==== {api-examples-title}
|
2017-03-30 00:07:55 +08:00
|
|
|
|
2019-09-09 22:45:37 +08:00
|
|
|
[source,console]
|
2017-03-30 00:07:55 +08:00
|
|
|
--------------------------------------------------
|
2018-12-09 02:57:16 +08:00
|
|
|
POST _watcher/_start
|
2017-03-30 00:07:55 +08:00
|
|
|
--------------------------------------------------
|
|
|
|
|
|
|
|
|
|
{watcher} returns the following response if the request is successful:
|
|
|
|
|
|
2019-09-06 04:47:18 +08:00
|
|
|
[source,console-result]
|
2017-03-30 00:07:55 +08:00
|
|
|
--------------------------------------------------
|
|
|
|
|
{
|
|
|
|
|
"acknowledged": true
|
|
|
|
|
}
|
|
|
|
|
--------------------------------------------------
|
