kibana/oas_docs/examples/create_index_threshold_rule_response.yaml
Kibana Machine d282c328f9
[8.x] [OpenAPI][ResponseOps] Edit descriptions for alerting rule API examples (#194080) (#194327)
# Backport

This will backport the following commits from `main` to `8.x`:
- [[OpenAPI][ResponseOps] Edit descriptions for alerting rule API
examples (#194080)](https://github.com/elastic/kibana/pull/194080)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2024-09-27T16:45:44Z","message":"[OpenAPI][ResponseOps]
Edit descriptions for alerting rule API examples
(#194080)","sha":"539ad61d377f8982f3358b1a753be45408c4998c","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Feature:Alerting","release_note:skip","v9.0.0","docs","v8.16.0","backport:version"],"title":"[OpenAPI][ResponseOps]
Edit descriptions for alerting rule API
examples","number":194080,"url":"https://github.com/elastic/kibana/pull/194080","mergeCommit":{"message":"[OpenAPI][ResponseOps]
Edit descriptions for alerting rule API examples
(#194080)","sha":"539ad61d377f8982f3358b1a753be45408c4998c"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/194080","number":194080,"mergeCommit":{"message":"[OpenAPI][ResponseOps]
Edit descriptions for alerting rule API examples
(#194080)","sha":"539ad61d377f8982f3358b1a753be45408c4998c"}},{"branch":"8.x","label":"v8.16.0","branchLabelMappingKey":"^v8.16.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
2024-09-27 13:16:38 -05:00

56 lines
No EOL
1.6 KiB
YAML

summary: Index threshold rule
description: The response for successfully creating an index threshold rule.
value:
actions:
- group: threshold met
id: dceeb5d0-6b41-11eb-802b-85b0c1bc8ba2
uuid: 07aef2a0-9eed-4ef9-94ec-39ba58eb609d
connector_type_id: .server-log
frequency:
notify_when: onActionGroupChange
summary: false
throttle: null
params:
level: info
message: "Rule {{rule.name}} is active for group {{context.group} :\n\n- Value: {{context.value}}\n- Conditions Met: {{context.conditions}} over {{rule.params.timeWindowSize}}{{rule.params.timeWindowUnit}}\n- Timestamp: {{context.date}}"
alert_delay:
active: 3
api_key_created_by_user: false
api_key_owner: elastic
consumer: alerts
created_at: '2022-06-08T17:20:31.632Z'
created_by: elastic
enabled: true
execution_status:
last_execution_date: '2022-06-08T17:20:31.632Z'
status: pending
id: 41893910-6bca-11eb-9e0d-85d233e3ee35
muted_alert_ids: []
mute_all: false
name: my rule
notify_when: null
params:
aggType: avg
termSize: 6
thresholdComparator: ">"
timeWindowSize: 5
timeWindowUnit: m
groupBy: top
threshold:
- 1000
index:
- ".test-index"
timeField: "@timestamp"
aggField: sheet.version
termField: name.keyword
revision: 0
rule_type_id: .index-threshold
running: false
schedule:
interval: 1m
scheduled_task_id: 425b0800-6bca-11eb-9e0d-85d233e3ee35
tags:
- cpu
throttle: null
updated_at: '2022-06-08T17:20:31.632Z'
updated_by: elastic