获取所有项目事件
所需角色
您的API密钥必须具有 Project Read Only
角色才能成功调用此资源。
请求
基本 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /groups/{groupId}/events
请求路径参数
名称 | 类型 | 说明 |
---|---|---|
groupId | 字符串 | 与所需事件关联的项目的唯一标识符。 |
请求查询参数
唯一查询参数
此端点接受以下查询参数来筛选返回的事件:
通用查询参数
此端点还接受所有返回值列表的端点通用的查询参数:
名称 | 类型 | 说明 | 默认 | ||||||
---|---|---|---|---|---|---|---|---|---|
pageNum | 整型 | 页码(从 1 开始)。 | 1 | ||||||
itemsPerPage | 整型 | 每页要返回的项目数,最多 500 个。 | 100 | ||||||
pretty | 布尔 | 指示显示正文是否应采用 prettyprint 格式。 | false | ||||||
envelope | 布尔 | 指示是否要将响应封装在信封中。 某些API客户端无法访问HTTP响应标头或状态代码。 要修复此问题,请在查询中设置 对于返回一个结果的终结点,响应体包括:
对于返回结果列表的端点, | 无 |
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
响应文档
响应JSON文档包括一个 result对象数组、一个link对象数组以及检索到的result对象总数。
名称 | 类型 | 说明 |
---|---|---|
results | 阵列 | 数组为 results 嵌入式文档部分中详细介绍的每一项包含一个对象。 |
links | 阵列 | 数组包含一个或多个指向子资源和/或相关资源的链接。 URL 之间的关系在 Web 链接规范中进行了解释。 |
totalCount | 数字 | 结果集中项目总数的整数计数。 如果对整个结果集进行分页,则它可能大于results数组中的对象数。 |
results
嵌入式文档
每个结果都是一个事件。
名称 | 类型 | 说明 |
---|---|---|
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?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 "links" : [ { 3 "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{groupId}/events?pretty=true&pageNum=1&itemsPerPage=100", 4 "rel" : "self" 5 }, { 6 "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{groupId}/events?pretty=true&itemsPerPage=100&pageNum=2", 7 "rel" : "next" 8 } ], 9 "results" : [ { 10 "created" : "2020-07-13T21:28:37Z", 11 "diffs" : [ { 12 "id" : "admin@admin", 13 "name" : null, 14 "params" : [ { 15 "display" : "Added Privilege", 16 "new" : "config.system.sessions: moveChunk", 17 "old" : null, 18 "param" : "config.system.sessions: moveChunk" 19 }, { 20 "display" : "Added Privilege", 21 "new" : "config.system.sessions: splitChunk", 22 "old" : null, 23 "param" : "config.system.sessions: splitChunk" 24 }, { 25 "display" : "Added Privilege", 26 "new" : "config.system.sessions: splitVector", 27 "old" : null, 28 "param" : "config.system.sessions: splitVector" 29 } ], 30 "priviileges" : [ { 31 "actions" : [ "moveChunk" ], 32 "resource" : { 33 "collection" : "system.sessions", 34 "db" : "config" 35 } 36 }, { 37 "actions" : [ "moveChunk" ], 38 "resource" : { 39 "collection" : "", 40 "db" : "" 41 } 42 }, { 43 "actions" : [ "enableSharding" ], 44 "resource" : { 45 "cluster" : true 46 } 47 }, { 48 "actions" : [ "cleanupOrphaned" ], 49 "resource" : { 50 "cluster" : true 51 } 52 }, { 53 "actions" : [ "flushRouterConfig" ], 54 "resource" : { 55 "cluster" : true 56 } 57 }, { 58 "actions" : [ "splitChunk" ], 59 "resource" : { 60 "collection" : "system.sessions", 61 "db" : "config" 62 } 63 }, { 64 "actions" : [ "splitChunk" ], 65 "resource" : { 66 "collection" : "", 67 "db" : "" 68 } 69 }, { 70 "actions" : [ "splitVector" ], 71 "resource" : { 72 "collection" : "system.sessions", 73 "db" : "config" 74 } 75 }, { 76 "actions" : [ "viewRole" ], 77 "resource" : { 78 "collection" : "", 79 "db" : "" 80 } 81 } ], 82 "roles" : [ { 83 "db" : "admin", 84 "role" : "readWriteAnyDatabase" 85 }, { 86 "db" : "admin", 87 "role" : "dbAdminAnyDatabase" 88 }, { 89 "db" : "admin", 90 "role" : "enableSharding" 91 }, { 92 "db" : "admin", 93 "role" : "backup" 94 }, { 95 "db" : "admin", 96 "role" : "clusterMonitor" 97 } ], 98 "status" : "MODIFIED", 99 "type" : "ROLES" 100 }, { 101 "id" : "sample-dataset-load@admin", 102 "name" : null, 103 "params" : [ ], 104 "priviileges" : null, 105 "roles" : [ { 106 "db" : "admin", 107 "role" : "readWriteAnyDatabase" 108 } ], 109 "status" : "NEW", 110 "type" : "USERS" 111 }, { 112 "id" : "10.16.0.6482-1", 113 "name" : null, 114 "params" : [ { 115 "display" : "Version", 116 "new" : "10.16.0.6482-1", 117 "old" : "10.12.0.6179-1", 118 "param" : "version" 119 } ], 120 "status" : "MODIFIED", 121 "type" : "AUTOMATION_AGENT" 122 } ], 123 "eventTypeName" : "AUTOMATION_CONFIG_PUBLISHED_AUDIT", 124 "groupId" : "{groupId}", 125 "id" : "{eventId}", 126 "isGlobalAdmin" : false, 127 "links" : [ { 128 "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{groupId}/events/{eventId}", 129 "rel" : "self" 130 } ] 131 }], 132 "totalCount" : 1 133 }