获取异常检测作业模型快照升级统计信息 API

编辑

获取异常检测作业模型快照升级统计信息 API编辑

检索异常检测作业模型快照升级的使用信息。

请求编辑

GET _ml/anomaly_detectors/<job_id>/model_snapshots/<snapshot_id>/_upgrade/_stats

GET _ml/anomaly_detectors/<job_id>,<job_id>/model_snapshots/_all/_upgrade/_stats

GET _ml/anomaly_detectors/_all/model_snapshots/_all/_upgrade/_stats

先决条件编辑

需要 monitor_ml 集群权限。此权限包含在 machine_learning_user 内置角色中。

描述编辑

异常检测作业模型快照升级是短暂的。只有在调用此 API 时正在进行的升级才会返回。

路径参数编辑

<job_id>
(字符串)异常检测作业的标识符。它可以是作业标识符、组名或通配符表达式。
<snapshot_id>

(字符串)模型快照的标识符。

您可以通过使用逗号分隔的快照 ID 列表,在单个 API 请求中获取多个异常检测作业模型快照升级的统计信息。您还可以使用通配符表达式或 _all

查询参数编辑

allow_no_match

(可选,布尔值)指定在以下情况下该怎么做:

  • 请求包含通配符表达式,并且没有匹配的作业。
  • 包含 _all 字符串或没有标识符,并且没有匹配项。
  • 包含通配符表达式,并且只有部分匹配。

默认值为 true,当没有匹配项时返回一个空的 jobs 数组,当有部分匹配项时返回结果的子集。如果此参数为 false,则当没有匹配项或只有部分匹配项时,请求将返回 404 状态代码。

响应正文编辑

API 返回一个异常检测作业模型快照升级状态对象的数组。所有这些属性都是信息性的;您无法更新它们的值。

assignment_explanation
(字符串)仅针对已启动的数据馈送,包含与节点选择相关的消息。
job_id
(字符串)异常检测作业的标识符。
node

(对象)包含运行升级任务的节点的属性。此信息仅适用于分配给节点的升级任务。

详细信息
attributes
(对象)列出节点属性,例如 ml.machine_memoryml.max_open_jobs 设置。
ephemeral_id
(字符串)节点的临时 ID。
id
(字符串)节点的唯一标识符。
name
(字符串)节点名称。例如,0-o0tOo
transport_address
(字符串)接受传输 HTTP 连接的主机和端口。
snapshot_id
(字符串)唯一标识模型快照的数字字符串。例如,1575402236000
state
(字符串)loading_old_statesaving_new_statestoppedfailed 之一。

响应代码编辑

404(缺少资源)
如果 allow_no_matchfalse,则此代码表示没有与请求匹配的资源,或者只有部分匹配请求的资源。

示例编辑

response = client.ml.get_model_snapshot_upgrade_stats(
  job_id: 'low_request_rate',
  snapshot_id: '_all'
)
puts response
GET _ml/anomaly_detectors/low_request_rate/model_snapshots/_all/_upgrade/_stats

API 返回以下结果

{
  "count" : 1,
  "model_snapshot_upgrades" : [
    {
      "job_id" : "low_request_rate",
      "snapshot_id" : "1828371",
      "state" : "saving_new_state",
      "node" : {
        "id" : "7bmMXyWCRs-TuPfGJJ_yMw",
        "name" : "node-0",
        "ephemeral_id" : "hoXMLZB0RWKfR9UPPUCxXX",
        "transport_address" : "127.0.0.1:9300",
        "attributes" : {
          "ml.machine_memory" : "17179869184",
          "ml.max_open_jobs" : "512"
        }
      },
      "assignment_explanation" : ""
    }
  ]
}