获取一个组织事件
所需角色
您的 API 密钥必须具有 Organization Member角色才能成功调用此资源。
请求
基本 URL： https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /orgs/{orgId}/events/{eventId}
请求路径参数
名称 | 类型 | 说明 |
|---|---|---|
orgId | 字符串 | 与所需事件关联的组织的唯一标识符。 |
eventId | 字符串 | 所需事件的唯一标识符。 |
请求查询参数
以下查询参数为可选参数：
查询参数 | 类型 | 说明 | 默认 |
|---|---|---|---|
pretty | 布尔 | 以 prettyprint 形式 显示响应 格式。 | false |
envelope | 布尔 | 指定是否将响应包装在信封中。 | false |
includeRaw | 布尔 | 指定是否在输出中包含 重要
| false |
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
名称 | 类型 | 说明 |
|---|---|---|
alertId | 字符串 | 与此事件关联的警报的唯一标识符。 |
alertConfigId | 字符串 | 与 alertId关联的警报配置的唯一标识符。 |
apiKeyId | 字符串 | 触发此事件的API 密钥的唯一标识符。 如果响应中存在此字段，则 Ops Manager 不会返回 |
clusterId | 字符串 | 此事件适用的集群的唯一标识符。 |
集群名称 | 字符串 | 应用此事件的集群的名称。 |
集合 | 字符串 | 发生事件的collection的名称。当 eventTypeName为DATA_EXPLORER或DATA_EXPLORER_CRUD时，可以存在此字段。 |
已创建 | 字符串 | ISO8601 格式的时间戳 触发此事件时的日期和时间（格式为 UTC ）。 |
currentValue | 对象 | 触发此事件的指标的当前值。 |
currentValue .number | 数字 | 指标的值。 |
currentValue .units | 字符串 | 值的相关单位。 例子测量内存消耗的指标将采用字节测量值，而测量时间的指标将采用时间单位。 接受的值为：
|
数据库 | 字符串 | 发生事件的数据库名称。 当 eventTypeName为DATA_EXPLORER或DATA_EXPLORER_CRUD时，可以存在此字段。 |
eventTypeName | 字符串 | |
groupId | 字符串 | 发生此事件的项目的唯一标识符。 |
hostId | 字符串 | 发生此事件的主机的唯一标识符。 |
主机名 | 字符串 | 发生此事件的主机的主机名、 FQDN 、 IPv4地址或IPv6地址。 |
id | 字符串 | 此事件的唯一标识符。 |
isGlobalAdmin | 布尔 | 指示触发此事件的用户是否具有 Global Monitoring Administrator角色的标志。 |
链接 | 对象数组 | 指向子资源和/或相关资源的一个或多个链接。响应中的所有 |
metricName | 字符串 | Go阈值的测量名称。 有关可能的值，请参阅下文。 |
opType | 字符串 | 生成事件的操作类型。 当 eventTypeName为DATA_EXPLORER或DATA_EXPLORER_CRUD时，此字段存在。 |
端口 | 整型 | 与此事件关联的主机的端口。 |
公钥 | 字符串 | 与触发此事件的API密钥关联的公钥。 如果响应中存在此字段，则 Ops Manager 不会返回 |
原始 | 文档 | 有关事件的其他元信息。 仅当 重要
|
远程地址 | 字符串 | 与触发事件的 Ops Manager 用户 (userId) 关联的 IP 地址。 |
ReplicaSetName | 字符串 | 副本集名称。 |
shardName | 字符串 | 与事件关联的分片的名称。 |
targetPublicKey | 字符串 | 事件针对的API 密钥的公钥。 |
targetUsername | 字符串 | 此事件针对的 Ops Manager 用户的用户名。 |
teamId | 字符串 | 与此事件关联的 Ops Manager 团队的唯一标识符。 |
用户 ID | 字符串 | 触发此事件的 Ops Manager 用户的唯一标识符。 如果响应中存在此字段，则 Ops Manager 不会返回 |
用户名 | 字符串 | 触发此事件的 Ops Manager 用户的用户名。 如果响应中存在此字段，则 Ops Manager 不会返回 |
accessListEntry | 字符串 | 事件针对的 API 密钥的访问列表条目。 |
请求示例
curl --user "{publicKey}:{privateKey}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{orgId}/events/{eventId}?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 "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 }