获取所有警报
注意
注意:群组和项目是同义词。您的 {PROJECT-ID}
与您的项目 ID 相同。对于现有群组,群组/项目 ID 保持不变。当引用说明时,此页面将使用“群组”这个更为人熟知的术语。端点仍如文档中所述。
基本 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/alerts
请求路径参数
Parameter | 类型 | 说明 |
---|---|---|
PROJECT-ID | 字符串 | (必需。) 项目标识符。 |
请求查询参数
名称 | 类型 | 必要性 | 说明 | 默认 |
---|---|---|---|---|
pageNum | 数字 | Optional | 从一开始的整数,用于返回结果的一部分。 | 1 |
itemsPerPage | 数字 | Optional | 每页要返回的项目数,最多 500 个。 | 100 |
pretty | 布尔 | Optional | 指示响应正文是否应采用 prettyprint 格式 的标志 格式。 | false |
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题,在查询中设置 对于返回结果列表的端点, | false |
名称 | 类型 | 必要性 | 说明 |
---|---|---|---|
status | 字符串 | Optional | 指定状态以仅返回具有指定状态的警报。 省略可返回所有警报。 Ops Manager 接受以下值:
|
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
响应文档
响应JSON文档包括一个 result对象数组、一个link对象数组以及检索到的result对象总数。
名称 | 类型 | 说明 |
---|---|---|
results | 阵列 | 数组为 results 嵌入式文档部分中详细介绍的每一项包含一个对象。 |
links | 阵列 | 数组包含一个或多个指向子资源和/或相关资源的链接。 URL 之间的关系在 Web 链接规范中进行了解释。 |
totalCount | 数字 | 结果集中项目总数的整数计数。 如果对整个结果集进行分页,则它可能大于results数组中的对象数。 |
results
嵌入式文档
每个结果都是一个警报。
名称 | 类型 | 说明 |
---|---|---|
acknowledged Until | 字符串 | ISO8601 格式的时间戳 确认警报之前的日期和时间格式( UTC )。 如果警报已被确认,Ops Manager 会返回此值。 |
acknowledgement Comment | 字符串 | 确认警报的用户留下的评论。 如果警报已被确认,Ops Manager 会返回此值。 |
acknowledging Username | 字符串 | 确认警报的用户的用户名。 如果警报已被确认,Ops Manager 会返回此值。 |
alertConfigId | 字符串 | 触发此警报的警报配置的唯一标识符。 |
clusterId | 字符串 | 此警报适用的集群的唯一标识符。 在以下情况下,Ops Manager 返回该值:
|
clusterName | 字符串 | 此警报适用的集群的名称。 在以下情况下,Ops Manager 返回该值:
|
created | 字符串 | ISO 格式的时间戳8601 打开警报时的日期和时间格式( UTC 格式)。 |
currentValue | 对象 | 触发警报的指标的当前值。 如果 |
currentValue .number | 数字 | 指标的值。 |
currentValue .units | 字符串 | 值的单位。 值取决于指标类型。 示例,测量内存消耗的指标将具有字节测量值,而测量时间的指标将具有时间单位。 Ops Manager 可能会返回:
|
eventTypeName | 字符串 | 触发警报的事件的名称。 接受的值为: 助手 自动化配置 备份- BI Connector 集群 已访问数据浏览器 主机 组织 项目 副本集(Replica Set) 团队 user 有关 Ops Manager 审核日志中包含的事件的完整列表,请参阅Audit 事件。 |
groupId | 字符串 | 为其打开此警报的群组的唯一标识符。 |
hostId | 字符串 | 指标所属主机的唯一标识符。 如果
|
hostnameAndPort | 字符串 | 警报适用的每个主机的主机名和端口。 这可以是主机名、 FQDN 、 IPv4地址或IPv6地址。 如果
|
id | 字符串 | 警报的唯一标识符。 |
lastNotified | 字符串 | ISO8601 格式的时间戳 上次为此警报发送通知的日期和时间格式( UTC 格式)。如果已发送通知, MongoDB Ops Manager将返回此值。 |
links | 对象数组 | 指向子资源和/或相关资源的一个或多个链接。 响应中的所有 |
metricName | 字符串 | |
replicaSetName | 字符串 | 副本集名称。 如果
|
resolved | 字符串 | ISO8601 格式的时间戳 警报关闭时的日期和时间格式( UTC 格式)。 如果 |
status | 字符串 | 警报的当前状态。 Ops Manager 可以返回以下之一:
|
sourceTypeName | 字符串 |
|
tags | 字符串数组 | 正在为此警报设置标识标签。 |
updated | 字符串 | ISO8601 格式的时间戳 上次更新警报时的日期和时间格式( UTC 格式)。 |
警报的测量类型
alerts
资源会在metricName
字段中返回测量类型。 仅当eventTypeName
设置为OUTSIDE_METRIC_THRESHOLD
时,该字段才存在。
主机测量
| 在serverStatus命令生成的 asserts 文档中找到 MongoDB 进程的断言的比率。 |
| 在后台刷新的数据量。 |
| 在 serverStatus 命令生成的 WiredTigerstorage engine和 文档中找到的 缓存和票证中的字节数。 wiredTiger.cache wiredTiger.concurrentTransactions |
| 在serverStatus命令生成的 connections 文档中找到的 MongoDB 进程的连接数。 |
| |
| MongoDB 进程的 Memory Issues 和Page Faults 的数量。 |
| 等待serverStatus命令生成的MongoDB进程锁的操作数。 MongoDB Ops Manager根据存储引擎的类型计算这些值。 |
| 索引 btree 操作的次数。 |
| 日志操作的数量。 |
| 在serverStatus命令收集的 mem 文档中找到的 MongoDB 进程的内存量。 |
| 在serverStatus命令收集的 network 文档中找到的 MongoDB 进程的吞吐量。 |
| MongoDB 进程的oplog 的持续时间和吞吐量。 |
| 从 MongoDB dbStats 命令收集的磁盘存储空间。 |
| 自上次启动 MongoDB 进程以来该进程的数据库操作速率,可在serverStatus命令收集的 opcounters 文档中找到。 |
| |
| 所选时间段内每秒返回、插入、更新或删除的文档的平均速率。 |
| 所选时间段内执行排序但无法使用索引执行排序的每秒操作的平均速率。 |
| 所选时间段内每次读取、写入或命令操作的平均执行时间(以毫秒为单位)。 适用于运行 MongoDB 3.4 或更高版本的主机。 |
| 主机在前一小时内重新启动的次数。 |
| 物理内存使用量(以字节为单位)。 |
| 网络吞吐量(以字节每秒为单位)。 |
| 正在使用的交换空间总量。 |
请求示例
以下返回所有OPEN
警报:
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --include \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/alerts?status=OPEN&pretty=true"
响应示例
响应标头
401 Unauthorized Content-Type: application/json;charset=ISO-8859-1 Date: {dateInUnixFormat} WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false Content-Length: {requestLengthInBytes} Connection: keep-alive
200 OK Vary: Accept-Encoding Content-Type: application/json Strict-Transport-Security: max-age=300 Date: {dateInUnixFormat} Connection: keep-alive Content-Length: {requestLengthInBytes} X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
响应体
1 { 2 "links" : [ { 3 "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/alerts?status=OPEN&pretty=true&pageNum=1&itemsPerPage=100", 4 "rel" : "self" 5 } ], 6 "results" : [ { 7 "alertConfigId" : "5953c5f380eef53887615fd4", 8 "created" : "2019-07-18T23:43:50Z", 9 "eventTypeName" : "MONITORING_AGENT_DOWN", 10 "groupId" : "{PROJECT-ID}", 11 "id" : "5d31043680eef5280d3664e0", 12 "lastNotified" : "2019-09-25T11:50:08Z", 13 "links" : [ { 14 "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/alerts/5d31043680eef5280d3664e0", 15 "rel" : "self" 16 } ], 17 "status" : "OPEN", 18 "tags" : [ ], 19 "updated" : "2019-07-18T23:43:50Z" 20 } ], 21 "totalCount" : 1 22 }