从一个组织返回一个事件
返回指定组织的单个事件。事件用于识别重要的数据库、帐单或安全活动或状态更改。要使用此资源,请求的服务帐户或 API 密钥必须具有“组织成员”角色。使用“从一个组织终结点返回事件”功能来检索已经过身份验证的用户有权访问的所有事件。
此资源仍在修订中,可能会有变动。
路径参数
-
唯一的24 -十六进制数字字符串,用于标识包含项目的组织。使用 /orgs 端点检索身份验证的用户有权访问权限的所有组织。
格式应符合以下模式:
^([a-f0-9]{24})$
。 -
唯一的 24 位十六进制数字字符串,用于标识要返回的事件。
格式应符合以下模式:
^([a-f0-9]{24})$
。
查询参数
-
指示应用程序是否将响应包装在
envelope
JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题,请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。默认值为
false
。 -
指示响应正文是否应采用 prettyprint 格式的标记。
默认值为
false
。Prettyprint -
指示是否在输出中包含原始文档的标记。原始文档包含有关事件的其他元信息。
默认值为
false
。
GET /api/atlas/v2/orgs/{orgId}/events/{eventId}
Atlas CLI
atlas api events getOrgEvent --help
import (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20230201001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.GetOrgEventApiParams{}
sdkResp, httpResp, err := client.EventsApi.
GetOrgEventWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2023-02-01+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2023-02-01+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true"
响应示例 (200)
Defaulteventviewfororg
{
"apiKeyId": "32b6e34b3d91647abb20e7b8",
"created": "2025-05-04T09:42:00Z",
"eventTypeName": "FEDERATION_SETTINGS_CREATED",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"isGlobalAdmin": true,
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"publicKey": "string",
"raw": {
"_t": "ALERT_AUDIT",
"alertConfigId": "32b6e34b3d91647abb20e7b8",
"cid": "32b6e34b3d91647abb20e7b8",
"cre": "2025-05-04T09:42:00Z",
"description": "Alert Acknowledged",
"gn": "Test Project",
"id": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"orgName": "Test Organization",
"severity": "INFO"
},
"remoteAddress": "216.172.40.186",
"userId": "32b6e34b3d91647abb20e7b8",
"username": "hello@example.com"
}
{
"alertId": "32b6e34b3d91647abb20e7b8",
"apiKeyId": "32b6e34b3d91647abb20e7b8",
"created": "2025-05-04T09:42:00Z",
"eventTypeName": "ALERT_ACKNOWLEDGED_AUDIT",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"isGlobalAdmin": true,
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"publicKey": "string",
"raw": {
"_t": "ALERT_AUDIT",
"alertConfigId": "32b6e34b3d91647abb20e7b8",
"cid": "32b6e34b3d91647abb20e7b8",
"cre": "2025-05-04T09:42:00Z",
"description": "Alert Acknowledged",
"gn": "Test Project",
"id": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"orgName": "Test Organization",
"severity": "INFO"
},
"remoteAddress": "216.172.40.186",
"userId": "32b6e34b3d91647abb20e7b8",
"username": "hello@example.com"
}
{
"alertConfigId": "32b6e34b3d91647abb20e7b8",
"apiKeyId": "32b6e34b3d91647abb20e7b8",
"created": "2025-05-04T09:42:00Z",
"eventTypeName": "ALERT_CONFIG_ADDED_AUDIT",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"isGlobalAdmin": true,
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"publicKey": "string",
"raw": {
"_t": "ALERT_AUDIT",
"alertConfigId": "32b6e34b3d91647abb20e7b8",
"cid": "32b6e34b3d91647abb20e7b8",
"cre": "2025-05-04T09:42:00Z",
"description": "Alert Acknowledged",
"gn": "Test Project",
"id": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"orgName": "Test Organization",
"severity": "INFO"
},
"remoteAddress": "216.172.40.186",
"userId": "32b6e34b3d91647abb20e7b8",
"username": "hello@example.com"
}
{
"apiKeyId": "32b6e34b3d91647abb20e7b8",
"created": "2025-05-04T09:42:00Z",
"eventTypeName": "API_KEY_CREATED",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"isGlobalAdmin": true,
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"publicKey": "string",
"raw": {
"_t": "ALERT_AUDIT",
"alertConfigId": "32b6e34b3d91647abb20e7b8",
"cid": "32b6e34b3d91647abb20e7b8",
"cre": "2025-05-04T09:42:00Z",
"description": "Alert Acknowledged",
"gn": "Test Project",
"id": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"orgName": "Test Organization",
"severity": "INFO"
},
"remoteAddress": "216.172.40.186",
"targetPublicKey": "zmmrboas",
"userId": "32b6e34b3d91647abb20e7b8",
"username": "hello@example.com",
"whitelistEntry": "0.0.0.0"
}
{
"apiKeyId": "32b6e34b3d91647abb20e7b8",
"created": "2025-05-04T09:42:00Z",
"eventTypeName": "SERVICE_ACCOUNT_CREATED",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"isGlobalAdmin": true,
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"publicKey": "string",
"raw": {
"_t": "ALERT_AUDIT",
"alertConfigId": "32b6e34b3d91647abb20e7b8",
"cid": "32b6e34b3d91647abb20e7b8",
"cre": "2025-05-04T09:42:00Z",
"description": "Alert Acknowledged",
"gn": "Test Project",
"id": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"orgName": "Test Organization",
"severity": "INFO"
},
"remoteAddress": "216.172.40.186",
"userId": "32b6e34b3d91647abb20e7b8",
"username": "hello@example.com"
}
{
"apiKeyId": "32b6e34b3d91647abb20e7b8",
"created": "2025-05-04T09:42:00Z",
"eventTypeName": "CHARGE_SUCCEEDED",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"invoiceId": "32b6e34b3d91647abb20e7b8",
"isGlobalAdmin": true,
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"paymentId": "32b6e34b3d91647abb20e7b8",
"publicKey": "string",
"raw": {
"_t": "ALERT_AUDIT",
"alertConfigId": "32b6e34b3d91647abb20e7b8",
"cid": "32b6e34b3d91647abb20e7b8",
"cre": "2025-05-04T09:42:00Z",
"description": "Alert Acknowledged",
"gn": "Test Project",
"id": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"orgName": "Test Organization",
"severity": "INFO"
},
"remoteAddress": "216.172.40.186",
"userId": "32b6e34b3d91647abb20e7b8",
"username": "hello@example.com"
}
{
"apiKeyId": "32b6e34b3d91647abb20e7b8",
"created": "2025-05-04T09:42:00Z",
"dbUserUsername": "user1",
"eventTypeName": "ORG_LIMIT_UPDATED",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"isGlobalAdmin": true,
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"publicKey": "string",
"raw": {
"_t": "ALERT_AUDIT",
"alertConfigId": "32b6e34b3d91647abb20e7b8",
"cid": "32b6e34b3d91647abb20e7b8",
"cre": "2025-05-04T09:42:00Z",
"description": "Alert Acknowledged",
"gn": "Test Project",
"id": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"orgName": "Test Organization",
"severity": "INFO"
},
"remoteAddress": "216.172.40.186",
"userId": "32b6e34b3d91647abb20e7b8",
"username": "hello@example.com",
"whitelistEntry": "0.0.0.0"
}
{
"apiKeyId": "32b6e34b3d91647abb20e7b8",
"created": "2025-05-04T09:42:00Z",
"eventTypeName": "ORG_CREATED",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"invoiceId": "32b6e34b3d91647abb20e7b8",
"isGlobalAdmin": true,
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"publicKey": "string",
"raw": {
"_t": "ALERT_AUDIT",
"alertConfigId": "32b6e34b3d91647abb20e7b8",
"cid": "32b6e34b3d91647abb20e7b8",
"cre": "2025-05-04T09:42:00Z",
"description": "Alert Acknowledged",
"gn": "Test Project",
"id": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"orgName": "Test Organization",
"severity": "INFO"
},
"remoteAddress": "216.172.40.186",
"userId": "32b6e34b3d91647abb20e7b8",
"username": "hello@example.com"
}
{
"apiKeyId": "32b6e34b3d91647abb20e7b8",
"created": "2025-05-04T09:42:00Z",
"eventTypeName": "TEAM_ADDED_TO_GROUP",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"isGlobalAdmin": true,
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"publicKey": "string",
"raw": {
"_t": "ALERT_AUDIT",
"alertConfigId": "32b6e34b3d91647abb20e7b8",
"cid": "32b6e34b3d91647abb20e7b8",
"cre": "2025-05-04T09:42:00Z",
"description": "Alert Acknowledged",
"gn": "Test Project",
"id": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"orgName": "Test Organization",
"severity": "INFO"
},
"remoteAddress": "216.172.40.186",
"teamId": "32b6e34b3d91647abb20e7b8",
"userId": "32b6e34b3d91647abb20e7b8",
"username": "hello@example.com"
}
{
"apiKeyId": "32b6e34b3d91647abb20e7b8",
"created": "2025-05-04T09:42:00Z",
"eventTypeName": "JOINED_ORG",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"isGlobalAdmin": true,
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"publicKey": "string",
"raw": {
"_t": "ALERT_AUDIT",
"alertConfigId": "32b6e34b3d91647abb20e7b8",
"cid": "32b6e34b3d91647abb20e7b8",
"cre": "2025-05-04T09:42:00Z",
"description": "Alert Acknowledged",
"gn": "Test Project",
"id": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"orgName": "Test Organization",
"severity": "INFO"
},
"remoteAddress": "216.172.40.186",
"targetUsername": "test.user@mongodb.com",
"userId": "32b6e34b3d91647abb20e7b8",
"username": "hello@example.com"
}
{
"apiKeyId": "32b6e34b3d91647abb20e7b8",
"created": "2025-05-04T09:42:00Z",
"eventTypeName": "GROUP_TAGS_MODIFIED",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"isGlobalAdmin": true,
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"publicKey": "string",
"raw": {
"_t": "ALERT_AUDIT",
"alertConfigId": "32b6e34b3d91647abb20e7b8",
"cid": "32b6e34b3d91647abb20e7b8",
"cre": "2025-05-04T09:42:00Z",
"description": "Alert Acknowledged",
"gn": "Test Project",
"id": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"orgName": "Test Organization",
"severity": "INFO"
},
"remoteAddress": "216.172.40.186",
"resourceId": "32b6e34b3d91647abb20e7b8",
"resourceType": "cluster",
"userId": "32b6e34b3d91647abb20e7b8",
"username": "hello@example.com"
}
{
"apiKeyId": "32b6e34b3d91647abb20e7b8",
"created": "2025-05-04T09:42:00Z",
"eventTypeName": "RESOURCE_POLICY_CREATED",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"isGlobalAdmin": true,
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"orgId": "32b6e34b3d91647abb20e7b8",
"publicKey": "string",
"raw": {
"_t": "ALERT_AUDIT",
"alertConfigId": "32b6e34b3d91647abb20e7b8",
"cid": "32b6e34b3d91647abb20e7b8",
"cre": "2025-05-04T09:42:00Z",
"description": "Alert Acknowledged",
"gn": "Test Project",
"id": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"orgName": "Test Organization",
"severity": "INFO"
},
"remoteAddress": "216.172.40.186",
"resourcePolicyId": "32b6e34b3d91647abb20e7b8",
"userId": "32b6e34b3d91647abb20e7b8",
"username": "hello@example.com"
}
响应示例 (401)
{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}
响应示例 (403)
{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
响应示例 (404)
{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}
响应示例 (500)
{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}