红帽全球峰会第 3 章 警报服务
3.1. 警报服务
3.1.1. CountAlerts
GET /v1/alertscount
CountAlerts 计算与 get 请求匹配的警报数量。
3.1.1.1. 描述
3.1.1.2. 参数
3.1.1.2.1. 查询参数
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
3.1.1.3. 返回类型
3.1.1.4. 内容类型
- application/json
3.1.1.5. 响应
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
3.1.1.6. Samples
3.1.2. DeleteAlerts
DELETE /v1/alerts
3.1.2.1. 描述
3.1.2.2. 参数
3.1.2.2.1. 查询参数
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| query.query | - | null | ||
| query.pagination.limit | - | null | ||
| query.pagination.offset | - | null | ||
| query.pagination.sortOption.field | - | null | ||
| query.pagination.sortOption.reversed | - | null | ||
| query.pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| query.pagination.sortOption.aggregateBy.distinct | - | null | ||
| 确认 | - | null |
3.1.2.3. 返回类型
3.1.2.4. 内容类型
- application/json
3.1.2.5. 响应
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
3.1.2.6. Samples
3.1.3. GetAlert
GET /v1/alerts/{id}
GetAlert 返回其 id 的警报。
3.1.3.1. 描述
3.1.3.2. 参数
3.1.3.2.1. 路径参数
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| id | X | null |
3.1.3.3. 返回类型
3.1.3.4. 内容类型
- application/json
3.1.3.5. 响应
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
3.1.3.6. Samples
3.1.4. GetAlertTimeseries
GET /v1/alerts/summary/timeseries
GetAlertTimeseries 返回按时间排序的警报。
3.1.4.1. 描述
3.1.4.2. 参数
3.1.4.2.1. 查询参数
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
3.1.4.3. 返回类型
3.1.4.4. 内容类型
- application/json
3.1.4.5. 响应
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
3.1.4.6. Samples
3.1.5. GetAlertsCounts
GET /v1/alerts/summary/counts
GetAlertsCounts 返回请求的集群或类别中的警报数量。
3.1.5.1. 描述
3.1.5.2. 参数
3.1.5.2.1. 查询参数
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| request.query | - | null | ||
| request.pagination.limit | - | null | ||
| request.pagination.offset | - | null | ||
| request.pagination.sortOption.field | - | null | ||
| request.pagination.sortOption.reversed | - | null | ||
| request.pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| request.pagination.sortOption.aggregateBy.distinct | - | null | ||
| groupBy | - | UNSET |
3.1.5.3. 返回类型
3.1.5.4. 内容类型
- application/json
3.1.5.5. 响应
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
3.1.5.6. Samples
3.1.6. GetAlertsGroup
GET /v1/alerts/summary/groups
GetAlertsGroup 返回按策略分组的警报。
3.1.6.1. 描述
3.1.6.2. 参数
3.1.6.2.1. 查询参数
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
3.1.6.3. 返回类型
3.1.6.4. 内容类型
- application/json
3.1.6.5. 响应
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
3.1.6.6. Samples
3.1.7. ListAlerts
GET /v1/alerts
list 返回警报的 slim 列表版本。
3.1.7.1. 描述
3.1.7.2. 参数
3.1.7.2.1. 查询参数
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
3.1.7.3. 返回类型
3.1.7.4. 内容类型
- application/json
3.1.7.5. 响应
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
3.1.7.6. Samples
3.1.8. ResolveAlert
PATCH /v1/alerts/{id}/resolve
ResolveAlert 将给定警报（按 ID）标记为已解析。
3.1.8.1. 描述
3.1.8.2. 参数
3.1.8.2.1. 路径参数
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| id | X | null |
3.1.8.2.2. 正文参数
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| 正文（body） | X |
3.1.8.3. 返回类型
对象
3.1.8.4. 内容类型
- application/json
3.1.8.5. 响应
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 |
|
| 0 | 意外错误响应。 |
3.1.8.6. Samples
3.1.9. ResolveAlerts
PATCH /v1/alerts/resolve
ResolveAlertsByQuery 将与搜索查询匹配的警报标记为已解析。
3.1.9.1. 描述
3.1.9.2. 参数
3.1.9.2.1. 正文参数
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| 正文（body） | X |
3.1.9.3. 返回类型
对象
3.1.9.4. 内容类型
- application/json
3.1.9.5. 响应
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 |
|
| 0 | 意外错误响应。 |
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}