获取一个项目事件
所需角色
您的API密钥必须具有 Project Read Only
角色才能成功调用此资源。
请求
基本 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /groups/{groupId}/events/{eventId}
请求路径参数
名称 | 类型 | 说明 |
---|---|---|
groupId | 字符串 | 与所需事件关联的项目的唯一标识符。 |
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 | 字符串 | 值的相关单位。 例子测量内存消耗的指标将采用字节测量值,而测量时间的指标将采用时间单位。 接受的值为:
|
database | 字符串 | 发生事件的数据库名称。 当 eventTypeName 为DATA_EXPLORER 或DATA_EXPLORER_CRUD 时,可以存在此字段。 |
diffs | 对象数组 | 在此事件期间对部署所做的更改。 注意Ops Manager 根据更改内容返回不同元素:用户权限或角色、恢复作业、自动化模块等。 此数组及其对象的列表并不详尽。 |
diffs .id | 字符串 | 在此事件中执行的差异的唯一标识符。 |
diffs .params | 对象数组 | 对给定资源所做更改的collection。 |
diffs .params .display | 字符串 | 进行更改时,在控制台的操作日志中显示的标签。 |
diffs .params .new | 字符串 | 已更改参数的新状态。 |
diffs .params .old | 字符串 | 已更改参数的初始状态。 |
diffs .params .param | 字符串 | 已更改参数的名称。 |
diffs .status | 字符串 | 对此资源所做更改的性质。
|
diffs .type | 字符串 | 已更改的资源。
|
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/groups/{groupId}/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 "created" : "2020-07-13T21:28:37Z", 3 "diffs" : [ { 4 "id" : "admin@admin", 5 "name" : null, 6 "params" : [ { 7 "display" : "Added Privilege", 8 "new" : "config.system.sessions: moveChunk", 9 "old" : null, 10 "param" : "config.system.sessions: moveChunk" 11 }, { 12 "display" : "Added Privilege", 13 "new" : "config.system.sessions: splitChunk", 14 "old" : null, 15 "param" : "config.system.sessions: splitChunk" 16 }, { 17 "display" : "Added Privilege", 18 "new" : "config.system.sessions: splitVector", 19 "old" : null, 20 "param" : "config.system.sessions: splitVector" 21 } ], 22 "priviileges" : [ { 23 "actions" : [ "moveChunk" ], 24 "resource" : { 25 "collection" : "system.sessions", 26 "db" : "config" 27 } 28 }, { 29 "actions" : [ "moveChunk" ], 30 "resource" : { 31 "collection" : "", 32 "db" : "" 33 } 34 }, { 35 "actions" : [ "enableSharding" ], 36 "resource" : { 37 "cluster" : true 38 } 39 }, { 40 "actions" : [ "cleanupOrphaned" ], 41 "resource" : { 42 "cluster" : true 43 } 44 }, { 45 "actions" : [ "flushRouterConfig" ], 46 "resource" : { 47 "cluster" : true 48 } 49 }, { 50 "actions" : [ "splitChunk" ], 51 "resource" : { 52 "collection" : "system.sessions", 53 "db" : "config" 54 } 55 }, { 56 "actions" : [ "splitChunk" ], 57 "resource" : { 58 "collection" : "", 59 "db" : "" 60 } 61 }, { 62 "actions" : [ "splitVector" ], 63 "resource" : { 64 "collection" : "system.sessions", 65 "db" : "config" 66 } 67 }, { 68 "actions" : [ "viewRole" ], 69 "resource" : { 70 "collection" : "", 71 "db" : "" 72 } 73 } ], 74 "roles" : [ { 75 "db" : "admin", 76 "role" : "readWriteAnyDatabase" 77 }, { 78 "db" : "admin", 79 "role" : "dbAdminAnyDatabase" 80 }, { 81 "db" : "admin", 82 "role" : "enableSharding" 83 }, { 84 "db" : "admin", 85 "role" : "backup" 86 }, { 87 "db" : "admin", 88 "role" : "clusterMonitor" 89 } ], 90 "status" : "MODIFIED", 91 "type" : "ROLES" 92 } 93 }