<job_id>: (可选，字符串) 异常检测作业的标识符。它可以是作业标识符、组名或通配符表达式。您可以通过使用组名、用逗号分隔的作业列表或通配符表达式，在一个 API 请求中获取多个异常检测作业的信息。您可以通过使用 _all、指定 * 作为作业标识符或省略标识符来获取所有异常检测作业的信息。

查询参数

编辑

allow_no_match

(可选，布尔值) 指定当请求

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

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

exclude_generated

(可选，布尔值) 指示在检索时是否应从配置中删除某些字段。这允许配置处于可接受的格式以便检索，然后添加到另一个集群。默认为 false。

响应体

编辑

API 返回异常检测作业资源数组。有关属性的完整列表，请参见创建异常检测作业 API。

blocked

(对象) 当出现时，它解释正在作业上执行的任务阻止其打开。

blocked 的属性

reason: (字符串) 作业被阻止的原因。值可以是 delete、reset、revert。每个值都表示正在执行相应的操作。
task_id: (字符串) 阻止操作的任务 ID。您可以使用任务管理 API 来监控进度。

create_time

(字符串) 创建作业的时间。例如，1491007356077。此属性仅供参考；您无法更改其值。

datafeed_config

(对象) 为当前异常检测作业配置的数据馈送。

datafeed_config 的属性

authorization

(可选，对象) 数据馈送用于运行其查询的安全权限。如果在最近一次更新数据馈送时禁用了 Elastic Stack 安全功能，则会省略此属性。

authorization 的属性

api_key

(对象) 如果使用 API 密钥对数据馈送进行了最近一次更新，则其名称和标识符将列在响应中。

api_key 的属性

id: (字符串) API 密钥的标识符。
name: (字符串) API 密钥的名称。

roles

(字符串数组) 如果使用用户 ID 对数据馈送进行了最近一次更新，则其在更新时的角色将列在响应中。

service_account

(字符串) 如果使用服务帐户对数据馈送进行了最近一次更新，则帐户名称将列在响应中。

datafeed_id

(可选，字符串) 唯一标识数据馈送的数字字符字符串。此标识符可以包含小写字母数字字符（a-z 和 0-9）、连字符和下划线。它必须以字母数字字符开头和结尾。

aggregations

(可选，对象) 如果设置，数据馈送将执行聚合搜索。对聚合的支持有限，应仅与低基数数据一起使用。有关更多信息，请参见聚合数据以提高性能。

chunking_config

(可选，对象) 数据馈送可能需要搜索很长时间段，例如几个月或几年。为了确保 Elasticsearch 上的负载得到管理，此搜索将被分成时间块。分块配置控制如何计算这些时间块的大小，这是一个高级配置选项。

chunking_config 的属性

mode

(字符串) 有三种可用模式

auto：动态计算块大小。当数据馈送不使用聚合时，这是默认值和推荐值。
manual：根据指定的 time_span 应用分块。当数据馈送使用聚合时，使用此模式。
off：不应用分块。

time_span

(时间单位) 每次搜索将查询的时间跨度。此设置仅在模式设置为 manual 时适用。例如：3h。

delayed_data_check_config

(可选，对象) 指定数据馈送是否检查缺失数据以及窗口的大小。例如：{"enabled": true, "check_window": "1h"}。

数据馈送可以选择搜索已经读取的索引，以确定是否随后已向索引添加任何数据。如果发现丢失的数据，则这表明 query_delay 选项设置得太低，并且数据在数据馈送经过该时间点后才被索引。参见使用延迟数据。

此检查仅在实时数据馈送上运行。

delayed_data_check_config 的属性

check_window: (时间单位) 搜索延迟数据的窗口时间。此时间窗口以最新的最终确定桶结束。默认为 null，这会导致在实时数据馈送运行时计算适当的 check_window。特别是，默认 check_window 跨度计算基于 2h 或 8 * bucket_span 的最大值。
enabled: (布尔值) 指定数据馈送是否定期检查延迟数据。默认为 true。

frequency

(可选，时间单位) 数据馈送在实时运行时进行计划查询的间隔。默认值对于短桶跨度是桶跨度，对于较长的桶跨度，是桶跨度的合理分数。例如：150s。当 frequency 短于桶跨度时，将写入最后一个（部分）桶的中间结果，然后最终被完整的桶结果覆盖。如果数据馈送使用聚合，则此值必须可被日期直方图聚合的间隔整除。

indices

(必需，数组) 索引名称数组。支持通配符。例如：["it_ops_metrics", "server*"]。

如果任何索引位于远程集群中，则机器学习节点需要具有 remote_cluster_client 角色。

indices_options

(可选，对象) 指定在搜索期间使用的索引扩展选项。

例如

{
   "expand_wildcards": ["all"],
   "ignore_unavailable": true,
   "allow_no_indices": "false",
   "ignore_throttled": true
}

有关这些选项的更多信息，请参见多目标语法。

job_id

(必需，字符串) 异常检测作业的标识符。

max_empty_searches

(可选，整数) 如果实时数据馈送从未见过任何数据（包括任何初始训练期间），则在返回没有文档的这么多实时搜索后，它将自动停止自身并关闭其关联的作业。换句话说，它将在 frequency 乘以 max_empty_searches 的实时操作后停止。如果未设置，则没有结束时间且未看到数据的馈送将保持启动状态，直到明确停止。默认情况下，此设置未设置。

query

(可选，对象) Elasticsearch 查询领域特定语言 (DSL)。此值对应于 Elasticsearch 搜索 POST 主体中的 query 对象。可以使用 Elasticsearch 支持的所有选项，因为此对象逐字传递给 Elasticsearch。默认情况下，此属性具有以下值：{"match_all": {"boost": 1}}。

query_delay

(可选，时间单位) 查询数据滞后于实际时间的秒数。例如，如果10:04 am 的数据可能要到10:06 am 才能在 Elasticsearch 中搜索到，则将此属性设置为 120 秒。默认值在60s和120s之间随机选择。这种随机性提高了在同一节点上运行多个作业时的查询性能。更多信息，请参见处理延迟数据。

runtime_mappings

(可选，对象) 指定数据馈送搜索的运行时字段。

例如

{
  "day_of_week": {
    "type": "keyword",
    "script": {
      "source": "emit(doc['@timestamp'].value.dayOfWeekEnum.getDisplayName(TextStyle.FULL, Locale.ENGLISH))"
    }
  }
}

script_fields

(可选，对象) 指定评估自定义表达式并将脚本字段返回给数据馈送的脚本。作业中的检测器配置对象可以包含使用这些脚本字段的函数。更多信息，请参见使用脚本字段转换数据和脚本字段。

scroll_size

(可选，无符号整数) 当数据馈送不使用聚合时，在 Elasticsearch 搜索中使用的size参数。默认值为1000。最大值为index.max_result_window的值，默认为 10,000。

finished_time

(字符串) 如果作业已关闭或失败，则为作业完成的时间，否则为null。此属性仅供参考；您无法更改其值。

job_type

(字符串) 预留供将来使用，目前设置为anomaly_detector。

job_version

(字符串) 创建作业时的机器学习配置版本号。

从 Elasticsearch 8.10.0 开始，使用新的版本号来跟踪机器学习插件中的配置和状态更改。此新的版本号与产品版本无关，并将独立递增。job_version值表示新的版本号。

model_snapshot_id: (字符串) 唯一标识模型快照的数字字符字符串。例如，1575402236000。

响应代码

编辑

404 (资源缺失): 如果allow_no_match为false，则此代码表示没有与请求匹配的资源，或者请求只有部分匹配。

示例

编辑

resp = client.ml.get_jobs(
    job_id="high_sum_total_sales",
)
print(resp)

response = client.ml.get_jobs(
  job_id: 'high_sum_total_sales'
)
puts response

const response = await client.ml.getJobs({
  job_id: "high_sum_total_sales",
});
console.log(response);

GET _ml/anomaly_detectors/high_sum_total_sales

API 返回以下结果

{
  "count": 1,
  "jobs": [
    {
      "job_id" : "high_sum_total_sales",
      "job_type" : "anomaly_detector",
      "job_version" : "8.4.0",
      "create_time" : 1655852735889,
      "finished_time" : 1655852745980,
      "model_snapshot_id" : "1575402237",
      "custom_settings" : {
        "created_by" : "ml-module-sample",
        ...
      },
      "datafeed_config" : {
        "datafeed_id" : "datafeed-high_sum_total_sales",
        "job_id" : "high_sum_total_sales",
        "authorization" : {
          "roles" : [
            "superuser"
          ]
        },
        "query_delay" : "93169ms",
        "chunking_config" : {
          "mode" : "auto"
        },
        "indices_options" : {
          "expand_wildcards" : [
            "open"
          ],
          "ignore_unavailable" : false,
          "allow_no_indices" : true,
          "ignore_throttled" : true
        },
        "query" : {
          "bool" : {
            "filter" : [
              {
                "term" : {
                  "event.dataset" : "sample_ecommerce"
                }
              }
            ]
          }
        },
        "indices" : [
          "kibana_sample_data_ecommerce"
        ],
        "scroll_size" : 1000,
        "delayed_data_check_config" : {
          "enabled" : true
        }
      },
      "groups" : [
        "kibana_sample_data",
        "kibana_sample_ecommerce"
      ],
      "description" : "Find customers spending an unusually high amount in an hour",
      "analysis_config" : {
        "bucket_span" : "1h",
        "detectors" : [
          {
            "detector_description" : "High total sales",
            "function" : "high_sum",
            "field_name" : "taxful_total_price",
            "over_field_name" : "customer_full_name.keyword",
            "detector_index" : 0
          }
        ],
        "influencers" : [
          "customer_full_name.keyword",
          "category.keyword"
        ],
        "model_prune_window": "30d"
      },
      "analysis_limits" : {
        "model_memory_limit" : "13mb",
        "categorization_examples_limit" : 4
      },
      "data_description" : {
        "time_field" : "order_date",
        "time_format" : "epoch_ms"
      },
      "model_plot_config" : {
        "enabled" : true,
        "annotations_enabled" : true
      },
      "model_snapshot_retention_days" : 10,
      "daily_model_snapshot_retention_after_days" : 1,
      "results_index_name" : "shared",
      "allow_lazy_open" : false
    }
  ]
}

« 获取影响因素 API 获取异常检测作业统计信息 API »