获取由一个全局警报配置触发的所有打开的警报
检索由 GLOBAL-ALERT-CONFIG-ID
标识的全局警报配置触发的所有打开的警报。
所需角色
您可以使用以下任何分配的角色成功调用此端点:
请求
基本 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /globalAlertConfigs/{GLOBAL-ALERT-CONFIG-ID}/alerts
请求路径参数
名称 | 类型 | 必要性 | 说明 |
---|---|---|---|
{GLOBAL-ALERT-CONFIG-ID} | 字符串 | 必需 | 要检索其打开警报的全局警报配置的唯一标识符。 |
请求查询参数
名称 | 类型 | 必要性 | 说明 | 默认 |
---|---|---|---|---|
pageNum | 数字 | Optional | 从一开始的整数,用于返回结果的一部分。 | 1 |
itemsPerPage | 数字 | Optional | 每页要返回的项目数,最多 500 个。 | 100 |
pretty | 布尔 | Optional | 指示响应正文是否应采用 prettyprint 格式 的标志 格式。 | false |
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题,在查询中设置 对于返回结果列表的端点, | false |
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
响应文档
响应JSON文档包括一个 result对象数组、一个link对象数组以及检索到的result对象总数。
名称 | 类型 | 说明 |
---|---|---|
results | 阵列 | 数组为 results 嵌入式文档部分中详细介绍的每一项包含一个对象。 |
links | 阵列 | 数组包含一个或多个指向子资源和/或相关资源的链接。 URL 之间的关系在 Web 链接规范中进行了解释。 |
totalCount | 数字 | 结果集中项目总数的整数计数。 如果对整个结果集进行分页,则它可能大于results数组中的对象数。 |
results
嵌入式文档
每个结果都是一个警报。
名称 | 类型 | 说明 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
acknowledgedUntil | 字符串 | ISO8601 格式的时间戳 已确认警报的日期和时间格式( UTC 格式)。如果用户确认此警报, MongoDB Ops Manager显示此字段。 | ||||||||
acknowledgementComment | 字符串 | 确认此警报的用户留下的注释。 如果用户确认此警报,Ops Manager 会显示此字段。 | ||||||||
acknowledgingUsername | 字符串 | 确认警报的用户的 Ops Manager 用户名。 如果用户确认此警报,Ops Manager 会显示此字段。 | ||||||||
alertConfigId | 字符串 | 触发此警报的全局警报配置的唯一标识符。 | ||||||||
clusterId | 字符串 | |||||||||
clusterName | 字符串 | |||||||||
created | 字符串 | ISO8601 格式的时间戳 创建警报时的日期和时间格式( UTC 格式)。 | ||||||||
currentValue | 对象 | 触发警报的指标的当前值。 Ops Manager 会为主机类别中的全球警报返回此字段。 | ||||||||
currentValue.number | 数字 | 指标的当前值。 | ||||||||
currentValue.units | 字符串 |
接受的值为:
示例,测量内存消耗的指标可以使用 | ||||||||
eventTypeName | 字符串 | |||||||||
groupId | 字符串 | 为其打开此警报的项目的唯一标识符。 | ||||||||
hostId | 字符串 | |||||||||
hostnameAndPort | 字符串 | |||||||||
id | 字符串 | 警报的唯一标识符。 | ||||||||
lastNotified | 字符串 | ISO8601 格式的时间戳 上次为此警报发送通知的日期和时间格式( UTC 格式)。如果MongoDB Ops Manager发送了通知,则 MongoDB MongoDB Ops Manager会显示此内容。 | ||||||||
metricName | 字符串 | Go值超出阈值的测量名称。如果 有关可能的值,请参阅全局警报的测量类型。 | ||||||||
replicaSetName | 字符串 | |||||||||
resolved | 字符串 | |||||||||
sourceTypeName | 字符串 | 正在备份的主机类型。 Ops Manager 会为备份类别中的全局警报返回此字段。 可能返回的值包括:
| ||||||||
status | 字符串 | 警报的当前状态。 可能返回的值包括:
| ||||||||
tags | 字符串数组 | 与此警报关联的标签。 | ||||||||
typeName | 字符串 | 此字段已弃用,将被忽略。 | ||||||||
updated | 字符串 | ISO8601 格式的时间戳 上次更新此警报时的日期和时间格式( UTC 格式)。 |
请求示例
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Accept: application/json" \ 3 --include \ 4 --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/globalAlertConfigs/{GLOBAL-ALERT-CONFIG-ID}/alerts"
响应示例
响应标头
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 "results": [{ 4 "alertConfigId": "{ALERT-CONFIG-ID}", 5 "created": "2019-11-29T20:26:30Z", 6 "eventTypeName": "BACKUP_AGENT_DOWN", 7 "groupId": "{PROJECT-ID}", 8 "id": "{ALERT-ID}", 9 "lastNotified": "2020-04-09T20:21:00Z", 10 "links": [], 11 "status": "OPEN", 12 "tags": [], 13 "typeName": "AGENT", 14 "updated": "2019-11-29T20:26:30Z" 15 }, 16 { 17 "alertConfigId": "{ALERT-CONFIG-ID}", 18 "created": "2019-11-29T20:43:00Z", 19 "eventTypeName": "BACKUP_AGENT_DOWN", 20 "groupId": "{PROJECT-ID}", 21 "id": "{ALERT-ID}", 22 "lastNotified": "2020-04-09T20:21:54Z", 23 "links": [], 24 "status": "OPEN", 25 "tags": [], 26 "typeName": "AGENT", 27 "updated": "2019-11-29T20:43:00Z" 28 }, 29 { 30 "alertConfigId": "{ALERT-CONFIG-ID}", 31 "created": "2019-11-30T12:27:07Z", 32 "eventTypeName": "BACKUP_AGENT_DOWN", 33 "groupId": "{PROJECT-ID}", 34 "id": "{ALERT-ID}", 35 "lastNotified": "2020-04-09T20:20:33Z", 36 "links": [], 37 "status": "OPEN", 38 "tags": [], 39 "typeName": "AGENT", 40 "updated": "2019-11-30T12:27:07Z" 41 } 42 ], 43 "totalCount": 3 44 }