获取规则类型 API
编辑获取规则类型 API编辑
检索用户有权访问的规则类型列表。
有关最新的 API 详细信息，请参阅开放 API 规范。
请求编辑
GET <kibana 主机>:<端口>/api/alerting/rule_types
GET <kibana 主机>:<端口>/s/<空间 ID>/api/alerting/rule_types
先决条件编辑
如果您对一个或多个 Kibana 功能具有读取权限，则 API 响应将包含有关相应规则类型的信息。例如，有一些规则类型与管理 > 堆栈规则功能、分析 > Discover和机器学习功能、可观测性和安全功能相关联。要获取与堆栈监控功能关联的规则类型，请使用monitoring_user内置角色。
有关更多详细信息，请参阅功能权限。
描述编辑
每个规则类型都包含授权使用者功能列表。对于每个功能，用户都有权对该类型的规则执行读取或所有操作。这使您能够确定可以读取、创建或修改哪些规则类型。如果要在 Kibana 中创建或编辑规则，则某些规则类型仅限于特定功能和应用程序。
路径参数编辑
-
空间 ID - （可选，字符串）空间的标识符。如果未在 URL 中提供
space_id，则使用默认空间。
响应正文编辑
每个规则类型在 API 响应中都具有以下属性
-
操作组 - （对象数组）规则类型可以为其安排操作的组的显式列表，每个组都包含操作组的唯一 ID 和人类可读的名称。规则
操作验证使用此配置来确保组有效。 -
操作变量 - （对象）规则类型通过操作参数模板中的上下文和状态提供的操作变量列表，以及简短的人类可读描述。当您在 Kibana 中创建规则时，它会使用此信息在操作参数编辑器中提示您输入这些变量。
-
警报 - （对象）有关此规则类型的警报作为数据文档的详细信息，包括任何自定义映射。
-
授权使用者 - （对象）有权访问规则类型的插件 ID 列表。
-
类别 - （字符串）规则类别，由特定于类别的维护窗口等功能使用。
-
默认操作组 ID - （字符串）规则类型组的默认 ID。
-
是否设置恢复上下文 - （布尔值）指示规则是否将上下文变量传递给其恢复操作。
-
在许可证中启用 - （布尔值）指示规则类型是启用还是禁用，具体取决于订阅。
-
是否具有警报映射 - （布尔值）指示规则类型是否具有警报数据的自定义映射。
-
ID - （字符串）规则类型的唯一标识符。
-
是否可导出 - （布尔值）指示规则类型是否可在堆栈管理 > 已保存的对象中导出。
-
所需的最低许可证 - （字符串）使用规则类型所需的订阅。
-
名称 - （字符串）规则类型的描述性名称。
-
生产者 - （字符串）生成此规则类型的应用程序的标识符。
-
恢复操作组 - （对象）当警报从活动状态变为非活动状态时要使用的操作组。
响应代码编辑
-
200 - 表示调用成功。
示例编辑
GET api/alerting/rule_types
例如，如果您对可观测性日志应用程序具有读取权限，则 API 将返回以下内容
[
{
"id":"logs.alert.document.count",
"name":"Log threshold",
"category": "observability",
"producer":"logs",
"alerts": {
"context": "observability.logs",
"mappings": {
"fieldMap": {
"kibana.alert.evaluation.threshold": {
"type": "scaled_float",
"scaling_factor": 100,
"required": false
},
"kibana.alert.evaluation.value": {
"type": "scaled_float",
"scaling_factor": 100,
"required": false
},
...
}
},
"useEcs": true,
"useLegacyAlerts": true
},
"enabled_in_license":true,
"recovery_action_group":{
"id":"recovered",
"name":"Recovered"
},
"action_groups":[
{
"id":"logs.threshold.fired",
"name":"Fired"
},
{
"id":"recovered",
"name":"Recovered"
}
],
"default_action_group_id":"logs.threshold.fired",
"minimum_license_required":"basic",
"is_exportable":true,
"rule_task_timeout":"5m",
"action_variables":{
"context":[
{
"name":"timestamp",
"description":"UTC timestamp of when the alert was triggered"
},
{
"name":"matchingDocuments",
"description":"The number of log entries that matched the conditions provided"
},
{
"name":"conditions",
"description":"The conditions that log entries needed to fulfill"
},
...
],
"state":[],
"params":[]
},
"authorized_consumers":{
"logs":{"read":true,"all":false},
"alerts":{"read":true,"all":false}
},
"does_set_recovery_context":true,
"has_alerts_mappings": true,
"has_fields_for_a_a_d": true
},
....
]