停止数据帧分析作业 API
编辑停止数据帧分析作业 API编辑
停止一个或多个数据帧分析作业。
请求编辑
POST _ml/data_frame/analytics/<data_frame_analytics_id>/_stop
POST _ml/data_frame/analytics/<data_frame_analytics_id>,<data_frame_analytics_id>/_stop
POST _ml/data_frame/analytics/_all/_stop
先决条件编辑
需要 manage_ml
集群权限。此权限包含在 machine_learning_admin
内置角色中。
描述编辑
数据帧分析作业在其生命周期中可以多次启动和停止。
您可以使用逗号分隔的数据帧分析作业列表或通配符表达式,在单个 API 请求中停止多个数据帧分析作业。您可以使用 _all 或通过将 * 指定为 <data_frame_analytics_id> 来停止所有数据帧分析作业。
路径参数编辑
-
<data_frame_analytics_id>
- (必填,字符串)数据帧分析作业的标识符。此标识符可以包含小写字母数字字符(a-z 和 0-9)、连字符和下划线。它必须以字母数字字符开头和结尾。
查询参数编辑
-
allow_no_match
-
(可选,布尔值)指定当请求
- 包含通配符表达式,并且没有匹配的数据帧分析作业时该怎么办。
- 包含
_all
字符串或没有标识符,并且没有匹配项时该怎么办。 - 包含通配符表达式,并且只有部分匹配项时该怎么办。
默认值为
true
,当没有匹配项时返回一个空的data_frame_analytics
数组,当只有部分匹配项时返回结果的子集。如果此参数为false
,则当没有匹配项或只有部分匹配项时,请求将返回404
状态代码。 -
force
- (可选,布尔值)如果为 true,则强制停止数据帧分析作业。
-
timeout
- (可选,时间单位)控制等待数据帧分析作业停止的时间。默认为 20 秒。
示例编辑
以下示例停止了 loganalytics
数据帧分析作业
response = client.ml.stop_data_frame_analytics( id: 'loganalytics' ) puts response
POST _ml/data_frame/analytics/loganalytics/_stop
当数据帧分析作业停止时,您将收到以下结果
{ "stopped" : true }