获取所有全局事件

在此页面上

所需角色

请求
请求路径参数
请求查询参数
请求正文参数
响应
响应文档
results 嵌入式文档
请求示例
响应示例
响应标头
响应体

MongoDB Ops Manager v6.0 将于 2025 1 月 EOL。尽快升级到更高的MongoDB Ops Manager版本。

所需角色

您的API密钥必须具有 Global Read Only角色才能成功调用此资源。

请求

基本 URL： https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /globalEvents

请求路径参数

此端点不使用 HTTP 请求路径参数。

请求查询参数

唯一查询参数

此端点接受以下查询参数来筛选返回的事件：

名称	类型	说明
minDate	字符串	仅返回创建日期大于或等于 ISO8601 格式的指定时间戳的事件日期和时间格式（采用 UTC 格式）。
maxDate	字符串	仅返回创建日期小于或等于 ISO8601 格式的指定时间戳的事件 UTC 格式的日期和时间。
eventType	字符串	仅返回指定类型的事件。接受的值包括：要查看生成警报的事件类型，请参阅警报类型。有关 Ops Manager 审核日志中包含的事件的完整列表，请参阅Audit 事件。

通用查询参数

此端点还接受所有返回值列表的端点通用的查询参数：

名称

类型

说明

默认

pageNum

整型

页码（从 1 开始）。

1

itemsPerPage

整型

每页要返回的项目数，最多 500 个。

100

pretty

布尔

指示显示正文是否应采用 prettyprint 格式。

false

envelope

布尔

指示是否要将响应封装在信封中。

某些API客户端无法访问HTTP响应标头或状态代码。要修复此问题，请在查询中设置"envelope" : true 。

对于返回一个结果的终结点，响应体包括：

状态	HTTP 响应代码
envelope	预期响应正文

对于返回结果列表的端点， results对象是一个信封。 Ops Manager 将status字段添加到响应正文。

无

请求正文参数

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

响应

响应文档

响应JSON文档包括一个 result对象数组、一个link对象数组以及检索到的result对象总数。

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

`results` 嵌入式文档

每个结果都是一个事件。

名称	类型	说明
alertId	字符串	与此事件关联的警报的唯一标识符。
alertConfigId	字符串	与`alertId`关联的警报配置的唯一标识符。
apiKeyId	字符串	触发此事件的API 密钥的唯一标识符。如果响应中存在此字段，则 Ops Manager 不会返回`userId`字段。
clusterId	字符串	此事件适用的集群的唯一标识符。
集群名称	字符串	应用此事件的集群的名称。
集合	字符串	发生事件的collection的名称。当`eventTypeName`为`DATA_EXPLORER`或`DATA_EXPLORER_CRUD`时，可以存在此字段。
已创建	字符串	ISO8601 格式的时间戳触发此事件时的日期和时间格式（ UTC 格式）。
currentValue	对象	触发此事件的指标的当前值。
currentValue .number	数字	指标的值。
currentValue .units	字符串	`currentValue.number`的单位。单位取决于指标类型。接受的值为： `RAW` `BITS` `BYTES` `KILOBITS` `KILOBYTES` `MEGABITS` `MEGABYTES` `GIGABITS` `GIGABYTES` `TERABYTES` `PETABYTES` `MILLISECONDS` `SECONDS` `MINUTES` `HOURS` `DAYS` 示例，测量内存消耗的指标可以使用`BYTES` ，而测量时间的指标则可以使用`HOURS` 。
database	字符串	发生事件的数据库名称。当`eventTypeName`为`DATA_EXPLORER`或`DATA_EXPLORER_CRUD`时，可以存在此字段。
eventTypeName	字符串	触发此事件的情况名称。要查看生成警报的事件类型，请参阅警报类型。有关 Ops Manager 审核日志中包含的事件的完整列表，请参阅Audit 事件。
groupId	字符串	发生此事件的项目的唯一标识符。
hostId	字符串	发生此事件的主机的唯一标识符。
主机名	字符串	发生此事件的主机的主机名、 FQDN 、 IPv4地址或IPv6地址。
id	字符串	此事件的唯一标识符。
isGlobalAdmin	布尔	指示触发此事件的用户是否具有`Global Monitoring Administrator`角色的标志。
链接	对象数组	指向子资源和/或相关资源的一个或多个链接。响应中的所有`links`数组至少包含一个名为`self`的链接。 URL 之间的关系在 Web 链接规范中进行了解释。
metricName	字符串	Go阈值的测量名称。有关可能的值，请参阅下文。
opType	字符串	生成事件的操作类型。当`eventTypeName`为`DATA_EXPLORER`或`DATA_EXPLORER_CRUD`时，此字段存在。
端口	整型	与此事件关联的主机的端口。
公钥	字符串	与触发此事件的API密钥关联的公钥。如果响应中存在此字段，则 Ops Manager 不会返回`username`字段。
远程地址	字符串	与触发事件的 Ops Manager 用户 (userId) 关联的 IP 地址。
ReplicaSetName	字符串	副本集名称。
shardName	字符串	与事件关联的分片的名称。
targetPublicKey	字符串	事件针对的API 密钥的公钥。
targetUsername	字符串	此事件针对的 Ops Manager 用户的用户名。
teamId	字符串	与此事件关联的 Ops Manager 团队的唯一标识符。
用户 ID	字符串	触发此事件的 Ops Manager 用户的唯一标识符。如果响应中存在此字段，则 Ops Manager 不会返回`apiKeyId`字段。
用户名	字符串	触发此事件的 Ops Manager 用户的用户名。如果响应中存在此字段，则 Ops Manager 不会返回`publicKey`字段。
accessListEntry	字符串	事件针对的 API 密钥的访问列表条目。

请求示例

curl --user "{publicKey}:{privateKey}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/globalEvents?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   "alertConfigId": "{alertConfigId}",
3   "alertId": "{alertId}",
4   "clusterId": "{clusterId}",
5   "clusterName": "Test Cluster",
6   "created": "2018-06-11T12:34:56Z",
7   "currentValue": {
8     "number": 50,
9     "units": "RAW"
10   },
11   "eventTypeName": "OUTSIDE_METRIC_THRESHOLD",
12   "groupId": "{groupId}",
13   "hostId": "{hostId}",
14   "hostname": "db.example.com",
15   "id": "{globalAlertId}",
16   "isGlobalAdmin": false,
17   "maintenanceWindowId": "{maintenanceWindowId}",
18   "metricName": "OPCOUNTER_CMD",
19   "orgId": "{orgId}",
20   "port": 27017,
21   "remoteAddress": "192.168.1.1",
22   "replicaSetName": "rs1",
23   "shardName": "sh1",
24   "userId": "{userId}",
25   "username": "john.doe@example.com",
26   "targetUsername": "jane.doe@example.com",
27   "teamId": "{teamId}"
28 }

后退

全局事件

来年

获取一个全局事件

1	{
2	"alertConfigId": "{alertConfigId}",
3	"alertId": "{alertId}",
4	"clusterId": "{clusterId}",
5	"clusterName": "Test Cluster",
6	"created": "2018-06-11T12:34:56Z",
7	"currentValue": {
8	"number": 50,
9	"units": "RAW"
10	},
11	"eventTypeName": "OUTSIDE_METRIC_THRESHOLD",
12	"groupId": "{groupId}",
13	"hostId": "{hostId}",
14	"hostname": "db.example.com",
15	"id": "{globalAlertId}",
16	"isGlobalAdmin": false,
17	"maintenanceWindowId": "{maintenanceWindowId}",
18	"metricName": "OPCOUNTER_CMD",
19	"orgId": "{orgId}",
20	"port": 27017,
21	"remoteAddress": "192.168.1.1",
22	"replicaSetName": "rs1",
23	"shardName": "sh1",
24	"userId": "{userId}",
25	"username": "john.doe@example.com",
26	"targetUsername": "jane.doe@example.com",
27	"teamId": "{teamId}"
28	}