/ /

/ /

获取所有警报

注意

注意：群组和项目是同义词。您的 {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	指示响应正文是否应采用美观打印格式的标志。	`false`
envelope	布尔	Optional	指示是否将响应包装在信封中的标志。某些API客户端无法访问权限HTTP响应标头或状态代码。要修复此问题，请在查询中设立`envelope : true`。对于返回结果列表的端点， `content`对象是一个信封。 Ops Manager 将`status`字段添加到响应正文。	`false`

名称	类型	必要性	说明
`status`	字符串	Optional	指定状态以仅返回具有指定状态的警报。省略可返回所有警报。 Ops Manager 接受以下值： `TRACKING` 返回状态为`TRACKING`的警报。如果警报的配置指定了通知延迟，则 Ops Manager 会为警报分配`TRACKING`状态，直到延迟期结束。延迟后，如果这种情况仍然存在，Ops Manager 会将状态设置为`OPEN` 。如果警报的配置有多个通知，并且每个通知都有自己的通知延迟，则 Ops Manager 使用最小延迟值来确定何时将警报从`TRACKING`移至`OPEN` 。 `OPEN` 要返回所有打开的警报。 `CLOSED` 要返回所有已关闭的警报。

请求正文参数

此端点不使用 HTTP 请求正文参数。

响应

响应文档

响应JSON 文档包括一个 result 对象大量、一个 link 对象大量和检索到的 result 对象总数。

名称	类型	说明
`results`	阵列	数组为`results` 嵌入式文档部分中详细介绍的每一项包含一个对象。
`links`	阵列	数组包含一个或多个指向子资源和/或相关资源的链接。 URL 之间的关系在 Web 链接规范中进行了解释。
`totalCount`	数字	结果集中项目总数的整数计数。如果对整个结果集进行分页，则它可能大于results数组中的对象数。

`results` 嵌入式文档

每个结果都是一个警报。

名称	类型	说明
`acknowledged` `Until`	字符串	采用 ISO 8601 日期和时间格式（UTC 时间）的时间戳，直到确认警报为止。如果警报已被确认，Ops Manager 会返回此值。
`acknowledgement` `Comment`	字符串	确认警报的用户留下的评论。如果警报已被确认，Ops Manager 会返回此值。
`acknowledging` `Username`	字符串	确认警报的用户的用户名。如果警报已被确认，Ops Manager 会返回此值。
`alertConfigId`	字符串	触发此警报的警报配置的唯一标识符。
`clusterId`	字符串	此警报适用的集群的唯一标识符。在以下情况下，Ops Manager 返回该值： `"eventTypeName" : "SHARDED_CLUSTER"`
`clusterName`	字符串	此警报适用的集群的名称。在以下情况下，Ops Manager 返回该值： `"eventTypeName" : "SHARDED_CLUSTER"`
`created`	字符串	打开警报时采用 ISO 8601 日期和时间格式（UTC 时间）的时间戳。
`currentValue`	对象	触发警报的指标的当前值。如果`"eventTypeName" : "OUTSIDE_METRIC_THRESHOLD"`，Ops Manager 返回此值。
`currentValue` `.number`	数字	指标的值。
`currentValue` `.units`	字符串	值的单位。值取决于指标类型。示例，测量内存消耗的指标将具有字节测量值，而测量时间的指标将具有时间单位。 Ops Manager 可能会返回： `RAW` `BITS` `BYTES` `KILOBITS` `KILOBYTES` `MEGABITS` `MEGABYTES` `GIGABITS` `GIGABYTES` `TERABYTES` `PETABYTES` `MILLISECONDS` `SECONDS` `MINUTES` `HOURS` `DAYS`
`eventTypeName`	字符串	触发警报的事件的名称。接受的值为：助手 `AUTOMATION_AGENT_DOWN` `AUTOMATION_AGENT_UP` `BACKUP_AGENT_CONF_CALL_FAILURE` `BACKUP_AGENT_DOWN` `BACKUP_AGENT_UP` `BACKUP_AGENT_VERSION_BEHIND` `BACKUP_AGENT_VERSION_CURRENT` `MONITORING_AGENT_DOWN` `MONITORING_AGENT_UP` `MONITORING_AGENT_VERSION_BEHIND` `MONITORING_AGENT_VERSION_CURRENT` `NEW_AGENT` 自动化配置 `AUTOMATION_CONFIG_PUBLISHED_AUDIT` 备份 `BAD_CLUSTERSHOTS` `CLUSTER_BLACKLIST_UPDATED_AUDIT` `CLUSTER_CHECKKPOINT_UPDATED_AUDIT` `CLUSTER_CREDENTIAL_UPDATED_AUDIT` `CLUSTER_SNAPSHOT_SCHEDULE_UPDATED_AUDIT` `CLUSTER_STATE_CHANGED_AUDIT` `CLUSTER_STORAGE_ENGINE_UPDATED_AUDIT` `CLUSTERSHOT_DELETED_AUDIT` `CLUSTERSHOT_EXPIRY_UPDATED_AUDIT` `CONSISTENT_BACKUP_CONFIGURATION` `GOOD_CLUSTERSHOT` `INCONSISTENT_BACKUP_CONFIGURATION` `INITIAL_SYNC_FINISHED_AUDIT` `INITIAL_SYNC_STARTED_AUDIT` `OPLOG_BEHIND` `OPLOG_CURRENT` `RESTORE_REQUESTED_AUDIT` `RESYNC_PERFORMED` `RESYNC_REQUIRED` `RS_BLACKLIST_UPDATED_AUDIT` `RS_CREDENTIAL_UPDATED_AUDIT` `RS_ROTATE_MASTER_KEY_AUDIT` `RS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT` `RS_STATE_CHANGED_AUDIT` `RS_STORAGE_ENGINE_UPDATED_AUDIT` `SNAPSHOT_DELETED_AUDIT` `SNAPSHOT_EXPIRY_UPDATED_AUDIT` `SYNC_PENDING_AUDIT` `SYNC_REQUIRED_AUDIT` BI Connector `BI_CONNECTOR_DOWN` `BI_CONNECTOR_UP` 集群 `CLUSTER_MONGOS_IS_MISSING` `CLUSTER_MONGOS_IS_PRESENT` `SHARD_ADDED` `SHARD_REMOVED` 已访问数据浏览器 `DATA_EXPLORER` `DATA_EXPLORER_CRUD` 主机 `ATTEMPT_KILLOP_AUDIT` `ATTEMPT_KILLSESSION_AUDIT` `DB_PROFILER_DISABLE_AUDIT` `DB_PROFILER_ENABLE_AUDIT` `DISABLE_HOST_AUDIT` `HIDE_AND_DISABLE_HOST_AUDIT` `HIDE_HOST_AUDIT` `HOST_DOWN` `HOST_DOWNGRADED` `HOST_IP_CHANGED_AUDIT` `HOST_NOW_PRIMARY` `HOST_NOW_SECONDARY` `HOST_NOW_STANDALONE` `HOST_RECOVERED` `HOST_RECOVERING` `HOST_SECURITY_CHECKUP_NOT_MET` `HOST_SSL_CERTIFICATE_CURRENT` `HOST_SSL_CERTIFICATE_STALE` `HOST_UP` `HOST_UPGRADED` `INSIDE_METRIC_THRESHOLD` `NEW_HOST` `OUTSIDE_METRIC_THRESHOLD` `PAUSE_HOST_AUDIT` `RESUME_HOST_AUDIT` `UNDELETE_HOST_AUDIT` `VERSION_BEHIND` `VERSION_CHANGED` `VERSION_CURRENT` 组织 `ALL_ORG_USERS_HAVE_MFA` `ORG_API_KEY_ADDED` `ORG_API_KEY_DELETED` `ORG_EMPLOYEE_ACCESS_RESTRICTED` `ORG_EMPLOYEE_ACCESS_UNRESTRICTED` `ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED` `ORG_PUBLIC_API_ACCESS_LIST_REQUIRED` `ORG_RENAMED` `ORG_TWO_FACTOR_AUTH_OPTIONAL` `ORG_TWO_FACTOR_AUTH_REQUIRED` `ORG_USERS_WITHOUT_MFA` 项目 `ALL_USERS_HAVE_MULTI_FACTOR_AUTH` `USERS_WITHOUT_MULTI_FACTOR_AUTH` 副本集(Replica Set) `CONFIGURATION_CHANGED` `ENOUGH_HEALTHY_MEMBERS` `MEMBER_ADDED` `MEMBER_REMOVED` `MULTIPLE_PRIMARIES` `NO_PRIMARY` `ONE_PRIMARY` `TOO_FEW_HEALTHY_MEMBERS` `TOO_MANY_ELECTIONS` `TOO_MANY_UNHEALTHY_MEMBERS` 团队 `TEAM_ADDED_TO_GROUP` `TEAM_CREATED` `TEAM_DELETED` `TEAM_NAME_CHANGED` `TEAM_REMOVED_FROM_GROUP` `TEAM_ROLES_MODIFIED` `TEAM_UPDATED` `USER_ADDED_TO_TEAM` user `INVITED_TO_GROUP` `INVITED_TO_ORG` `JOIN_GROUP_REQUEST_APPROVED_AUDIT` `JOIN_GROUP_REQUEST_DENIED_AUDIT` `JOINED_TEAM` `REMOVED_FROM_TEAM` `REQUESTED_TO_JOIN_GROUP` 有关 Ops Manager 审核日志中包含的事件的完整列表，请参阅Audit 事件。
`groupId`	字符串	为其打开此警报的群组的唯一标识符。
`hostId`	字符串	指标所属主机的唯一标识符。如果`"eventTypeName"`设置为以下值之一，则 Ops Manager 会返回此值： `HOST_DOWN` `OUTSIDE_METRIC_THRESHOLD` `REPLICA_SET`
`hostnameAndPort`	字符串	警报适用的每个托管的主机名和端口。这可以是主机名、FQDN、IPv4解决或 IPv6解决。如果`"eventTypeName"`设置为以下值之一，则 Ops Manager 会返回此值： `HOST_DOWN` `OUTSIDE_METRIC_THRESHOLD` `REPLICA_SET`
`id`	字符串	警报的唯一标识符。
`lastNotified`	字符串	为该警报发送最后一次通知时采用 ISO 8601 日期和时间格式（UTC 时间）的时间戳。如果已发送通知， Ops Manager将返回此值。
`links`	对象数组	指向子资源或相关资源的一个或多个链接。响应中的所有 `links` 数组至少包含一个名为 `self` 的链接。URL之间的关系在 Web 链接规范中进行了解释。
`metricName`	字符串	Go阈值的测量名称。如果`"eventTypeName"`设置为`OUTSIDE_METRIC_THRESHOLD`，Ops Manager会返回此值。有关可能的值，请参阅警报的测量类型。
`replicaSetName`	字符串	副本集名称。如果`"eventTypeName"`设置为以下值之一，则 Ops Manager 会返回此值： `BACKUP` `HOST_DOWN` `OUTSIDE_METRIC_THRESHOLD` `REPLICA_SET`
`resolved`	字符串	关闭警报时采用 ISO 8601 日期和时间格式（UTC 时间）的时间戳。如果`"status" : "CLOSED"`，Ops Manager 返回此值。
`status`	字符串	警报的当前状态。 Ops Manager 可以返回以下之一： `TRACKING` 警报条件存在，但持续时间尚未超过定义的通知延迟。有关详细信息，请参阅请求查询参数。 `OPEN` `CLOSED` `CANCELLED`
`sourceTypeName`	字符串	`"eventTypeName" : "BACKUP"`时正在备份的主机的类型。 Ops Manager 可以返回以下之一： `REPLICA_SET` `SHARDED_CLUSTER` `CONFIG_SERVER`
`tags`	字符串数组	正在为此警报设置标识标签。
`updated`	字符串	上次更新警报时采用 ISO 8601 日期和时间格式（UTC 时间）的时间戳。

警报的测量类型

alerts资源会在metricName字段中返回测量类型。仅当eventTypeName设置为OUTSIDE_METRIC_THRESHOLD时，该字段才存在。

主机测量

`ASSERT_REGULAR` `ASSERT_WARNING` `ASSERT_MSG` `ASSERT_USER`	在命令生成的 `serverStatus`文档中找到MongoDB进程的断言的比率。`asserts`
`BACKGROUND_FLUSH_AVG`	在后台刷新的数据量。
`CACHE_BYTES_READ_INTO` `CACHE_BYTES_WRITTEN_FROM` `CACHE_DIRTY_BYTES` `CACHE_USED_BYTES` `TICKETS_AVAILABLE_READS` `TICKETS_AVAILABLE_WRITE`	WiredTiger存储引擎缓存的字节数以及在 `wiredTiger.cachewiredTiger.concurrentTransactionsserverStatus`命令生成的和文档中找到的票证。
`CONNECTIONS`	在命令生成的文档中找到的MongoDB进程的连接数。`connectionsserverStatus`
`CURSORS_TOTAL_OPEN` `CURSORS_TOTAL_TIMED_OUT`	在`metrics.cursor` `serverStatus`命令生成的文档中找到的MongoDB进程的游标数量。
`EXTRA_INFO_PAGE_FAULTS` `GLOBAL_ACCESSES_NOT_IN_MEMORY` `GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN`	MongoDB 进程的`Memory Issues`和`Page Faults`的数量。
`GLOBAL_LOCK_CURRENT_QUEUE_TOTAL` `GLOBAL_LOCK_CURRENT_QUEUE_READERS` `GLOBAL_LOCK_CURRENT_QUEUE_WRITERS`	等待命令生成的MongoDB进程锁的操作数。 Ops`serverStatus` Manager根据存储引擎的类型计算这些值。
`INDEX_COUNTERS_BTREE_ACCESSES` `INDEX_COUNTERS_BTREE_HITS` `INDEX_COUNTERS_BTREE_MISSES` `INDEX_COUNTERS_BTREE_MISS_RATIO`	索引 btree 操作的次数。
`JOURNALING_COMMITS_IN_WRITE_LOCK` `JOURNALING_MB` `JOURNALING_WRITE_DATA_FILES_MB`	日志操作的数量。
`MEMORY_RESIDENT` `MEMORY_VIRTUAL` `MEMORY_MAPPED` `COMPUTED_MEMORY`	在`mem` `serverStatus`命令收集的文档中找到的MongoDB进程的内存量。
`NETWORK_BYTES_IN` `NETWORK_BYTES_OUT` `NETWORK_NUM_REQUESTS`	在`network` `serverStatus`命令收集的文档中找到的MongoDB进程的吞吐量。
`OPLOG_RATE_GB_PER_HOUR` `OPLOG_MASTER_TIME` `OPLOG_MASTER_LAG_TIME_DIFF` `OPLOG_SLAVE_LAG_MASTER_TIME`	MongoDB 进程的oplog 的持续时间和吞吐量。
`DB_STORAGE_TOTAL` `DB_DATA_SIZE_TOTAL`	从 MongoDB `dbStats`命令收集的磁盘存储空间。
`OPCOUNTER_CMD` `OPCOUNTER_QUERY` `OPCOUNTER_UPDATE` `OPCOUNTER_DELETE` `OPCOUNTER_GETMORE` `OPCOUNTER_INSERT`	自上次启动MongoDB进程以来该进程的数据库操作速率，可在`opcounters` `serverStatus`命令收集的文档中找到。
`OPCOUNTER_REPL_CMD` `OPCOUNTER_REPL_UPDATE` `OPCOUNTER_REPL_DELETE` `OPCOUNTER_REPL_INSERT`	在命令收集的文档中找到MongoDB从节点上的数据库操作的速率。`opcountersReplserverStatus`
`DOCUMENT_METRICS_RETURNED` `DOCUMENT_METRICS_INSERTED` `DOCUMENT_METRICS_UPDATED` `DOCUMENT_METRICS_DELETED`	所选时间段内每秒返回、插入、更新或删除的文档的平均速率。
`OPERATIONS_SCAN_AND_ORDER`	所选时间段内执行排序但无法使用索引执行排序的每秒操作的平均速率。
`OP_EXECUTION_TIME_READS` `OP_EXECUTION_TIME_WRITES` `OP_EXECUTION_TIME_COMMANDS`	所选时间段内每次读取、写入或命令操作的平均执行时间（以毫秒为单位）。适用于运行 MongoDB 3.4 或更高版本的主机。
`RESTARTS_IN_LAST_HOUR`	主机在前一小时内重新启动的次数。
`SYSTEM_MEMORY_USED` `SYSTEM_MEMORY_FREE` `SYSTEM_MEMORY_AVAILABLE`	物理内存使用量（以字节为单位）。
`SYSTEM_NETWORK_BYTES_IN` `SYSTEM_NETWORK_BYTES_OUT`	网络吞吐量（以字节每秒为单位）。
`SWAP_USAGE_USED` `SWAP_USAGE_FREE`	正在使用的交换空间总量。

`QUERY_EXECUTOR_SCANNED`	在查询和查询计划评估期间扫描索引项的平均速率，可在`totalKeysExamined` `explain`命令的值中找到。
`QUERY_EXECUTOR_SCANNED_OBJECTS`	在查询和查询计划评估期间每秒扫描文档的平均速率，可在`totalDocsExamined` `explain`命令的值中找到。
`QUERY_TARGETING_SCANNED_PER_RETURNED`	扫描的索引项数与返回的文档数的比率。
`QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED`	扫描的文档数量与返回的文档数量的比率。

请求示例

以下返回所有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"

响应示例

响应标头

HTTP/1.1 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

HTTP/1.1 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 }

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	}

获取所有警报

注意

Resource

请求路径参数

请求查询参数

请求正文参数

响应

响应文档

results 嵌入式文档

警报的测量类型

主机测量

请求示例

响应示例

响应标头

响应体

`results` 嵌入式文档