检索所有全局警报。
所需角色
您可以使用以下任何分配的角色成功调用此端点：
请求
基本 URL： https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /globalAlerts请求路径参数
此端点不使用 HTTP 请求路径参数。
请求查询参数
名称 | 类型 | 必要性 | 说明 | 默认 |
|---|---|---|---|---|
pageNum | 数字 | Optional | 从一开始的整数，用于返回结果的一部分。 |
|
itemsPerPage | 数字 | Optional | 每页要返回的项目数，最多 500 个。 |
|
pretty | 布尔 | Optional |
| |
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，在查询中设置 对于返回结果列表的端点， |
|
名称 | 类型 | 必要性 | 说明 | 默认 |
|---|---|---|---|---|
| 字符串 | Optional | 要返回的警报的状态。 MongoDB Ops Manager返回与您指示的状态匹配的警报。 接受的值包括：
| 无 |
| 字符串 | Optional | 要返回的警报的创建日期，采用ISO 8601格式。Ops Manager返回在您指定的日期或之后创建的警报。 | 无 |
| 字符串 | Optional | 要返回的警报的创建日期，以ISO 8601为单位。Ops Manager返回在您指定的日期或之前创建的警报。 | 无 |
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
响应文档
响应 JSON 文档包括 result 对象数组、link 对象数组和检索到的 result 对象的总数。
名称 | 类型 | 说明 |
|---|---|---|
| 阵列 | 数组为 |
| 阵列 | 数组包含一个或多个指向子资源和/或相关资源的链接。 URL 之间的关系在 Web 链接规范中进行了解释。 |
| 数字 | 结果集中项目总数的整数计数。 如果对整个结果集进行分页，则它可能大于results数组中的对象数。 |
results 嵌入式文档
每个结果都是一个警报。
名称 | 类型 | 说明 |
|---|---|---|
| 字符串 | 时间戳在 ISO 8601 日期和时间格式，使用 UTC 来确认警报。MongoDB Ops Manager 会在用户确认此警报后显示此字段。 |
| 字符串 | 确认此警报的用户留下的注释。 如果用户确认此警报，Ops Manager 会显示此字段。 |
| 字符串 | 确认警报的用户的 Ops Manager 用户名。 如果用户确认此警报，Ops Manager 会显示此字段。 |
| 字符串 | 触发此警报的全局警报配置的唯一标识符。 |
| 字符串 | |
| 字符串 | |
| 字符串 | 时间戳，采用 ISO 8601 日期和时间格式，时区为 UTC，创建警报时。 |
| 对象 | 触发警报的指标的当前值。 Ops Manager 会为主机类别中的全球警报返回此字段。 |
| 数字 | 指标的当前值。 |
| 字符串 |
接受的值为：
示例，测量内存消耗的指标可以使用 |
| 字符串 | |
| 字符串 | 为其打开此警报的项目的唯一标识符。 |
| 字符串 | |
| 字符串 | |
| 字符串 | 警报的唯一标识符。 |
| 字符串 | 针对此警报上次发送通知时的时间戳，采用 ISO 8601 日期和时间格式（UTC 时间）。MongoDB Ops Manager 会显示此信息，前提是 Ops Manager 已发送了通知。 |
| 字符串 | Go值超出阈值的测量名称。如果 有关可能的值，请参阅全局警报的测量类型。 |
| 字符串 | |
| 字符串 | 关闭警报时采用 ISO 8601 日期和时间格式（UTC 时间）的时间戳。当 |
| 字符串 | 正在备份的主机类型。 Ops Manager 会为备份类别中的全局警报返回此字段。 可能返回的值包括：
|
| 字符串 | 警报的当前状态。 可能返回的值包括：
|
| 字符串数组 | 与此警报关联的标签。 |
| 字符串 | 此字段已弃用，将被忽略。 |
| 字符串 | 上次更新此警报时采用 ISO 8601 日期和时间格式（UTC 时间）的时间戳。 |
请求示例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/globalAlerts"响应示例
响应标头
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}响应体
{ "links": [], "results": [{ "alertConfigId": "{ALERT-CONFIG-ID}", "created": "2019-11-29T20:26:30Z", "eventTypeName": "BACKUP_AGENT_DOWN", "groupId": "{PROJECT-ID}", "id": "{ALERT-ID}", "lastNotified": "2020-04-09T20:21:00Z", "links": [], "status": "OPEN", "tags": [], "typeName": "AGENT", "updated": "2019-11-29T20:26:30Z" }, { "alertConfigId": "{ALERT-CONFIG-ID}", "created": "2019-11-29T20:43:00Z", "eventTypeName": "BACKUP_AGENT_DOWN", "groupId": "{PROJECT-ID}", "id": "{ALERT-ID}", "lastNotified": "2020-04-09T20:21:54Z", "links": [], "status": "OPEN", "tags": [], "typeName": "AGENT", "updated": "2019-11-29T20:43:00Z" }, { "alertConfigId": "{ALERT-CONFIG-ID}", "created": "2019-11-30T12:27:07Z", "eventTypeName": "BACKUP_AGENT_DOWN", "groupId": "{PROJECT-ID}", "id": "{ALERT-ID}", "lastNotified": "2020-04-09T20:20:33Z", "links": [], "status": "OPEN", "tags": [], "typeName": "AGENT", "updated": "2019-11-30T12:27:07Z" } ], "totalCount": 3}