从一个组织返回事件

获取 /api/atlas/v2/orgs/{orgId}/events

返回指定组织的事件。事件用于标识重要的数据库、计费或安全活动或状态更改。要使用此资源,请求的服务帐户或API密钥必须具有“组织成员”角色。

此资源仍在修订中,可能会有变动。

路径参数

  • orgId 字符串 必需

    唯一的24 -十六进制数字字符串,用于标识包含项目的组织。使用 /orgs 端点检索身份验证的用户有权访问权限的所有组织。

    格式应符合以下模式:^([a-f0-9]{24})$

查询参数

  • envelope 布尔

    指示应用程序是否将响应包装在envelope JSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题,请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。

    默认值为false

  • includeCount 布尔

    标志,用于指示响应是否返回响应中的列项总数 (totalCount)。

    默认值为true

  • itemsPerPage 整型

    响应每页返回的列项数。

    最小值为 1,最大值为 500。默认值为 100

  • pageNum 整型

    显示响应返回的当前总对象集的页面编号。

    最小值为 1。默认值为 1

  • pretty 布尔

    指示响应正文是否应采用 prettyprint 格式的标记。

    默认值为false

    Prettyprint
  • eventType 大量[对象| string]

    此时记录的事件类别。

    重要提示:事件类型值的完整列表经常更改。

    以下之一:

    值为 ALERT_ACKNOWLEDGED_AUDITALERT_UNACKNOWLEDGED_AUDIT

    取值为 ALERT_CONFIG_DISABLED_AUDITALERT_CONFIG_ENABLED_AUDITALERT_CONFIG_ADDED_AUDITALERT_CONFIG_DELETED_AUDITALERT_CONFIG_CHANGED_AUDIT

    取值为 API_KEY_CREATEDAPI_KEY_DELETEDAPI_KEY_ACCESS_LIST_ENTRY_ADDEDAPI_KEY_ACCESS_LIST_ENTRY_DELETEDAPI_KEY_ROLES_CHANGEDAPI_KEY_DESCRIPTION_CHANGEDAPI_KEY_ADDED_TO_GROUPAPI_KEY_REMOVED_FROM_GROUPAPI_KEY_UI_IP_ACCESS_LIST_INHERITANCE_ENABLEDAPI_KEY_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED

    值为 SERVICE_ACCOUNT_CREATEDSERVICE_ACCOUNT_DELETEDSERVICE_ACCOUNT_ROLES_CHANGEDSERVICE_ACCOUNT_DETAILS_CHANGEDSERVICE_ACCOUNT_ADDED_TO_GROUPSERVICE_ACCOUNT_REMOVED_FROM_GROUPSERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDEDSERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETEDSERVICE_ACCOUNT_SECRET_ADDEDSERVICE_ACCOUNT_SECRET_DELETEDSERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLEDSERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED

    值为 CHARGE_SUCCEEDEDCHARGE_FAILEDCHARGE_PROCESSINGCHARGE_PENDING_REVERSALBRAINTREE_CHARGE_FAILEDINVOICE_CLOSEDCHECK_PAYMENT_RECEIVEDWIRE_TRANSFER_PAYMENT_RECEIVEDDISCOUNT_APPLIEDCREDIT_ISSUEDCREDIT_PULLED_FWDCREDIT_END_DATE_MODIFIEDPROMO_CODE_APPLIEDPAYMENT_FORGIVENREFUND_ISSUEDACCOUNT_DOWNGRADEDACCOUNT_UPGRADEDACCOUNT_MODIFIEDSUPPORT_PLAN_ACTIVATEDSUPPORT_PLAN_CANCELLEDSUPPORT_PLAN_CANCELLATION_SCHEDULEDINITIATE_SALESFORCE_SERVICE_CLOUD_SYNCINVOICE_ADDRESS_CHANGEDINVOICE_ADDRESS_ADDEDPREPAID_PLAN_ACTIVATED, ELASTIC_INVOICING_MODE_ACTIVATED, ELASTIC_INVOICING_MODE_DEACTIVATED, TERMINATE_PAID_SERVICES, BILLING_EMAIL_ADDRESS_ADDED, BILLING_EMAIL_ADDRESS_CHANGED, BILLING_EMAIL_ADDRESS_REMOVED, AWS_BILLING_ACCOUNT_CREDIT_ISSUED, GCP_BILLING_ACCOUNT_CREDIT_ISSUED, CREDIT_SFOLID_MODIFIED, PREPAID_PLAN_MODIFIED, AWS_USAGE_REPORTED, AZURE_USAGE_REPORTED, GCP_USAGE_REPORTEDVERCEL_USAGE_REPORTEDBECAME_PAYING_ORGNEW_LINKED_ORGUNLINKED_ORGORG_LINKED_TO_PAYING_ORGORG_UNLINKED_FROM_PAYING_ORGORG_UNLINK_REQUESTEDORG_UNLINK_CANCELLEDPAYMENT_UPDATED_THROUGH_APIAZURE_BILLING_ACCOUNT_CREDIT_ISSUEDCREDIT_START_DATE_MODIFIEDCREDIT_ELASTIC_INVOICING_MODIFIED, CREDIT_TYPE_MODIFIED, CREDIT_AMOUNT_CENTS_MODIFIED, CREDIT_AMOUNT_REMAINING_CENTS_MODIFIED, CREDIT_TOTAL_BILLED_CENTS_MODIFIED, CREDIT_AWS_CUSTOMER_ID_MODIFIED, CREDIT_AWS_PRODUCT_CODE_MODIFIED, CREDIT_GCP_MARKETPLACE_ENTITLEMENT_ID_MODIFIED, CREDIT_AZURE_SUBSCRIPTION_ID_MODIFIED, CREDIT_AZURE_PRIVATE_PLAN_ID_MODIFIED, TARGETED_REBILL_EXECUTED, LEGACY_REBILL_EXECUTED, EVERGREEN_DEAL_CANCELLED, GRACE_PERIOD_ACTIVATEDGRACE_PERIOD_NO_LONGER_IN_EFFECTPENDING_DEAL_ACTIVATION_ADDEDPENDING_DEAL_ACTIVATION_CANCELEDPENDING_DEAL_APPLIEDPENDING_DEAL_ACTIVATION_FAILEDEVERGREEN_PRIORITY_MODIFIED

    值为 FEDERATION_SETTINGS_CREATEDFEDERATION_SETTINGS_DELETEDFEDERATION_SETTINGS_UPDATEDIDENTITY_PROVIDER_CREATEDIDENTITY_PROVIDER_UPDATEDIDENTITY_PROVIDER_DELETEDIDENTITY_PROVIDER_ACTIVATEDOIDC_IDENTITY_PROVIDER_UPDATEDIDENTITY_PROVIDER_DEACTIVATEDIDENTITY_PROVIDER_JWKS_REVOKEDOIDC_IDENTITY_PROVIDER_ENABLEDOIDC_IDENTITY_PROVIDER_DISABLEDDOMAINS_ASSOCIATEDDOMAIN_CREATEDDOMAIN_DELETEDDOMAIN_VERIFIEDORG_SETTINGS_CONFIGUREDORG_SETTINGS_UPDATEDORG_SETTINGS_DELETEDRESTRICT_ORG_MEMBERSHIP_ENABLEDRESTRICT_ORG_MEMBERSHIP_DISABLEDROLE_MAPPING_CREATEDROLE_MAPPING_UPDATEDROLE_MAPPING_DELETED

    值为 GROUP_DELETEDGROUP_CREATEDGROUP_MOVED

    值为 MLAB_MIGRATION_COMPLETEDMLAB_MIGRATION_TARGET_CLUSTER_CREATEDMLAB_MIGRATION_DATABASE_USERS_IMPORTEDMLAB_MIGRATION_IP_WHITELIST_IMPORTEDMLAB_MIGRATION_TARGET_CLUSTER_SETMLAB_MIGRATION_DATABASE_RENAMEDMLAB_MIGRATION_LIVE_IMPORT_STARTEDMLAB_MIGRATION_LIVE_IMPORT_READY_FOR_CUTOVERMLAB_MIGRATION_LIVE_IMPORT_CUTOVER_COMPLETEMLAB_MIGRATION_LIVE_IMPORT_ERRORMLAB_MIGRATION_LIVE_IMPORT_CANCELLEDMLAB_MIGRATION_DUMP_AND_RESTORE_TEST_STARTEDMLAB_MIGRATION_DUMP_AND_RESTORE_TEST_SKIPPEDMLAB_MIGRATION_DUMP_AND_RESTORE_STARTEDMLAB_MIGRATION_SUPPORT_PLAN_SELECTEDMLAB_MIGRATION_SUPPORT_PLAN_OPTED_OUT

    值为 ORG_LIMIT_UPDATED

    值为 ORG_CREATEDCUSTOM_SESSION_TIMEOUT_MODIFIEDSECURITY_CONTACT_MODIFIEDORG_CREDIT_CARD_ADDEDORG_CREDIT_CARD_UPDATEDORG_CREDIT_CARD_CURRENTORG_CREDIT_CARD_ABOUT_TO_EXPIREORG_PAYPAL_LINKEDORG_PAYPAL_UPDATEDORG_PAYPAL_CANCELLEDORG_OVERRIDE_PAYMENT_METHOD_ADDEDORG_ACTIVATEDORG_TEMPORARILY_ACTIVATEDORG_SUSPENSION_DATE_CHANGEDORG_SUSPENDEDORG_ADMIN_SUSPENDEDORG_ADMIN_LOCKEDORG_CLUSTERS_DELETEDORG_CLUSTERS_PAUSEDORG_LOCKEDORG_UNDER_FINANCIAL_PROTECTIONORG_NO_FINANCIAL_PROTECTIONORG_RENAMEDALL_ORG_USERS_HAVE_MFAORG_USERS_WITHOUT_MFA, ORG_INVOICE_UNDER_THRESHOLD, ORG_INVOICE_OVER_THRESHOLD, ORG_DAILY_BILL_UNDER_THRESHOLD, ORG_DAILY_BILL_OVER_THRESHOLD, ORG_GROUP_CHARGES_UNDER_THRESHOLD, ORG_GROUP_CHARGES_OVER_THRESHOLD, ORG_TWO_FACTOR_AUTH_REQUIRED, ORG_TWO_FACTOR_AUTH_OPTIONAL, ORG_PUBLIC_API_ACCESS_LIST_REQUIRED, ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED, ORG_EMPLOYEE_ACCESS_RESTRICTED, ORG_EMPLOYEE_ACCESS_UNRESTRICTED, ORG_SFDC_ACCOUNT_ID_CHANGEDORG_CONNECTED_TO_MLABORG_DISCONNECTED_FROM_MLABORG_IDP_CERTIFICATE_CURRENTORG_IDP_CERTIFICATE_ABOUT_TO_EXPIREORG_CONNECTED_TO_VERCELORG_DISCONNECTED_TO_VERCELORG_CONNECTION_UNINSTALLED_FROM_VERCELORG_UI_IP_ACCESS_LIST_ENABLEDORG_UI_IP_ACCESS_LIST_DISABLEDORG_EDITED_UI_IP_ACCESS_LIST_ENTRIESORG_SERVICE_ACCOUNT_MAX_SECRET_VALIDITY_EDITEDORG_SERVICE_ACCOUNT_SECRETS_EXPIREDORG_SERVICE_ACCOUNT_SECRETS_NO_LONGER_EXPIREDORG_SERVICE_ACCOUNT_SECRETS_EXPIRINGORG_SERVICE_ACCOUNT_SECRETS_NO_LONGER_EXPIRINGORG_MONGODB_VERSION_EOL_EXTENSION_ACCEPTEDORG_MONGODB_VERSION_EOL_EXTENSION_PENDINGORG_MONGODB_VERSION_EOL_EXTENSION_CANCELLEDGROUP_MOVED_FROM_ORGSANDBOX_ENABLED_FOR_ORGSANDBOX_DISABLED_FOR_ORG

    值为 AWS_SELF_SERVE_ACCOUNT_LINKEDAWS_SELF_SERVE_ACCOUNT_LINK_PENDINGAWS_SELF_SERVE_ACCOUNT_CANCELLEDAWS_SELF_SERVE_ACCOUNT_LINK_FAILEDGCP_SELF_SERVE_ACCOUNT_LINK_PENDINGGCP_SELF_SERVE_ACCOUNT_LINK_FAILEDAZURE_SELF_SERVE_ACCOUNT_LINKEDAZURE_SELF_SERVE_ACCOUNT_LINK_PENDINGAZURE_SELF_SERVE_ACCOUNT_CANCELLEDAZURE_SELF_SERVE_ACCOUNT_LINK_FAILEDGCP_SELF_SERVE_ACCOUNT_LINKEDGCP_SELF_SERVE_ACCOUNT_CANCELLEDVERCEL_SELF_SERVE_ACCOUNT_LINKEDVERCEL_SELF_SERVE_ACCOUNT_LINK_PENDINGVERCEL_SELF_SERVE_ACCOUNT_CANCELLEDVERCEL_SELF_SERVE_ACCOUNT_LINK_FAILEDVERCEL_INVOICE_CREATEDVERCEL_INVOICE_NOT_PAIDVERCEL_INVOICE_PAIDVERCEL_INVOICE_REFUNDED

    值为 SUPPORT_EMAILS_SENT_SUCCESSFULLYSUPPORT_EMAILS_SENT_FAILURE

    取值为 TEAM_CREATEDTEAM_DELETEDTEAM_UPDATEDTEAM_NAME_CHANGEDTEAM_ADDED_TO_GROUPTEAM_REMOVED_FROM_GROUPTEAM_ROLES_MODIFIED

    取值为 JOINED_ORGJOINED_TEAMINVITED_TO_ORGORG_INVITATION_DELETEDREMOVED_FROM_ORGREMOVED_FROM_TEAMUSER_ROLES_CHANGED_AUDITORG_FLEX_CONSULTING_PURCHASEDORG_FLEX_CONSULTING_PURCHASE_FAILEDINVITED_TO_TEAM

    值为 TAGS_MODIFIEDGROUP_TAGS_MODIFIED

    取值为 RESOURCE_POLICY_CREATEDRESOURCE_POLICY_MODIFIEDRESOURCE_POLICY_DELETEDRESOURCE_POLICY_VIOLATED

  • includeRaw 布尔

    指示是否在输出中包含原始文档的标记。原始文档包含有关事件的其他元信息。

    默认值为false

  • maxDate string(date-time)

    MongoDB Cloud 停止返回事件的日期和时间。此参数使用 UTC 格式的 ISO 8601 时间戳格式。

    ISO 8601
  • minDate string(date-time)

    MongoDB Cloud 开始返回事件的日期和时间。此参数使用 UTC 格式的 ISO 8601 时间戳格式。

    ISO 8601

响应

  • 200 application/vnd.atlas.2023-01-01+json

    正常

    隐藏响应属性 显示响应属性 对象
    • 结果 大量[对象]

      MongoDB Cloud 在完成此请求时提供的返回文档列表。

      以下之一:
    • 总计数 integer(int32)

      可用文档总数。如果 includeCount设立为 false,MongoDB Cloud 会忽略此值。总数为估计值,可能不准确。

      最小值为 0

  • 400 application/json

    错误请求。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。

  • 401 application/json

    未经授权。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。

  • 403 application/json

    Forbidden.

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。

  • 404 application/json

    未找到。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。

  • 500 application/json

    内部服务器错误。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      错误请求详情。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        描述客户端请求中的所有违规行为。

        隐藏字段属性 显示字段属性 对象
        • 描述 字符串 必需

          关于请求元素错误的原因的描述。

        • 字段 字符串 必需

          指向请求正文中字段的路径。

    • 详细信息 字符串

      描述导致每种错误类型的具体条件或原因。

    • 错误 integer(int32) 必需

      与此错误一起返回的 HTTP 状态代码。

      外部文档
    • 错误代码 字符串 必需

      返回此错误时附带应用程序错误代码。

    • 参数 大量[对象]

      用于提供更多错误信息的参数。

    • 原因 字符串

      随此错误返回的应用程序错误消息。

GET /api/atlas/v2 /orgs/{orgId}/events
atlas api events listOrgEvents --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.ListOrgEventsApiParams{}
	sdkResp, httpResp, err := client.EventsApi.
		ListOrgEventsWithParams(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?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?pretty=true"
响应示例 (200)
{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "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"
    }
  ],
  "totalCount": 42
}
响应示例 (400)
{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}
响应示例 (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"
}