所需角色
您的 API 密钥必须具有Project Read Only角色才能成功调用此资源。
请求
基本 URL: https://cloud.mongodb.com/api/public/v1.0
GET /groups/{groupId}/events/{eventId}请求路径参数
名称 | 类型 | 说明 |
|---|---|---|
groupId | 字符串 | 与所需事件关联的项目的唯一标识符。 |
eventId | 字符串 | 所需事件的唯一标识符。 |
请求查询参数
以下查询参数为可选参数:
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
名称 | 类型 | 说明 |
|---|---|---|
alertId | 字符串 | 与此事件关联的警报的唯一标识符。 |
alertConfigId | 字符串 | 与 |
apiKeyId | 字符串 | 触发此事件的API 密钥的唯一标识符。 如果响应中存在此字段,则 Cloud Manager 不会返回 |
clusterId | 字符串 | 此事件适用的集群的 ID。 |
集群名称 | 字符串 | 应用此事件的集群的名称。 |
集合 | 字符串 | 发生事件的collection的名称。当 |
已创建 | 字符串 | 触发此事件时采用 ISO 8601 日期和时间格式(UTC 时间)的时间戳。 |
currentValue | 对象 | 触发此事件的指标的当前值。 |
currentValue | 数字 | 指标的值。 |
currentValue | 字符串 | 值的相关单位。 示例,测量内存消耗的指标将具有字节测量值,而测量时间的指标将具有时间单位。 接受的值为:
|
database | 字符串 | 发生事件的数据库名称。 当 |
eventTypeName | 字符串 | 触发此事件的情况名称。 要查看生成警报的事件类型,请参阅警报类型。 |
groupId | 字符串 | 发生此事件的项目的 ID。 |
hostId | 字符串 | 发生此事件的主机的 ID。 |
主机名 | 字符串 | 发生此事件的托管的 主机名、FQDN、IPv4解决或 IPv6解决。 |
id | 字符串 | 此事件的唯一标识符。 |
invoiceId | 字符串 | 与此事件关联的发票的唯一标识符。 |
isGlobalAdmin | 布尔 | 指示触发此事件的用户是否为 MongoDB 员工的标志。 |
链接 | 对象数组 | 指向子资源和/或相关资源的一个或多个链接。响应中的所有 |
metricName | 字符串 | Go阈值的测量名称。 有关可能的值,请参阅下文。 |
opType | 字符串 | 生成事件的操作类型。 当 |
PaymentId | 字符串 | 与此事件相关的发票付款的唯一标识符。 |
端口 | 整型 | 与此事件关联的主机的端口。 |
publicKey | 字符串 | 与触发此事件的API密钥关联的公钥。 如果响应中存在此字段,则 Cloud Manager 不会返回 |
原始 | 文档 | 有关事件的其他元信息。 仅当 重要提示: |
远程地址 | 字符串 | 与触发事件的 Cloud Manager 用户 (userId) 关联的 IP 地址。 |
ReplicaSetName | 字符串 | 副本集名称。 |
shardName | 字符串 | 与事件关联的分片的名称。 |
targetPublicKey | 字符串 | 事件针对的 API 密钥的公钥。 |
targetUsername | 字符串 | 此事件所针对的 Cloud Manager 用户的用户名。 |
teamId | 字符串 | 与此事件关联的 Cloud Manager 团队的唯一标识符。 |
用户 ID | 字符串 | 触发此事件的 Cloud Manager 用户的唯一标识符。 如果响应中存在此字段,则 Cloud Manager 不会返回 |
用户名 | 字符串 | 触发此事件的 Cloud Manager 用户的用户名。 如果响应中存在此字段,Cloud Manager 不会返回 |
accessListEntry | 字符串 | 事件针对的 API 密钥的访问列表条目。 |
请求示例
curl --user "{publicKey}:{privateKey}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{groupId}/events/{eventId}?pretty=true"响应示例
响应标头
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}响应体
{ "created" : "2020-07-13T21:28:37Z", "diffs" : [ { "id" : "admin@admin", "name" : null, "params" : [ { "display" : "Added Privilege", "new" : "config.system.sessions: moveChunk", "old" : null, "param" : "config.system.sessions: moveChunk" }, { "display" : "Added Privilege", "new" : "config.system.sessions: splitChunk", "old" : null, "param" : "config.system.sessions: splitChunk" }, { "display" : "Added Privilege", "new" : "config.system.sessions: splitVector", "old" : null, "param" : "config.system.sessions: splitVector" } ], "priviileges" : [ { "actions" : [ "moveChunk" ], "resource" : { "collection" : "system.sessions", "db" : "config" } }, { "actions" : [ "moveChunk" ], "resource" : { "collection" : "", "db" : "" } }, { "actions" : [ "enableSharding" ], "resource" : { "cluster" : true } }, { "actions" : [ "cleanupOrphaned" ], "resource" : { "cluster" : true } }, { "actions" : [ "flushRouterConfig" ], "resource" : { "cluster" : true } }, { "actions" : [ "splitChunk" ], "resource" : { "collection" : "system.sessions", "db" : "config" } }, { "actions" : [ "splitChunk" ], "resource" : { "collection" : "", "db" : "" } }, { "actions" : [ "splitVector" ], "resource" : { "collection" : "system.sessions", "db" : "config" } }, { "actions" : [ "viewRole" ], "resource" : { "collection" : "", "db" : "" } } ], "roles" : [ { "db" : "admin", "role" : "readWriteAnyDatabase" }, { "db" : "admin", "role" : "dbAdminAnyDatabase" }, { "db" : "admin", "role" : "enableSharding" }, { "db" : "admin", "role" : "backup" }, { "db" : "admin", "role" : "clusterMonitor" } ], "status" : "MODIFIED", "type" : "ROLES" }}