公共预览版：请在以下位置提供反馈：返回指定组织的所有事件。
事件用于标识重要的数据库、计费或安全活动或状态更改。请求的 API 密钥必须具备组织成员角色，才能使用此资源。
此资源仍在修订中，可能会有变动。
1此命令是自动生成的，对应:1 和Atlas API端点 https://www.mongodb.com/zh-cn/docs/atlas/reference/api-resources-spec/v2 /# 标签/Events/ operation/listOrganizationEvents。
有关更多信息和示例，请参阅上面链接的参考API文档。
语法
atlas api events listOrganizationEvents [options]
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
--envelope | envelope | false | 指示应用程序是否将响应包装在信封JSON对象中的标志。某些API客户端无法访问权限HTTP响应标头或状态代码。要修复此问题，请在查询中设立Envelope=true。返回结果列表的端点将结果对象用作信封。应用程序将状态参数添加到响应正文中。 |
--eventType | 字符串数组 | false | 此时记录的事件类别。 重要提示：事件类型值的完整列表经常更改。 |
-h，--help | false | listOrganizationEvents 帮助 | |
--includeCount | false | 标志，用于指示响应是否返回响应中的列项总数 (totalCount)。 | |
--includeRaw | false | 指示是否在输出中包含原始文档的标记。原始文档包含有关事件的其他元信息。 | |
--itemsPerPage | int | false | 响应每页返回的列项数。 |
--maxDate | 字符串 | false | MongoDB Cloud 停止返回事件的日期和时间。此参数使用 UTC 格式的 ISO 8601 时间戳格式。 |
--minDate | 字符串 | false | MongoDB Cloud 开始返回事件的日期和时间。此参数使用 UTC 格式的 ISO 8601 时间戳格式。 |
--orgId | 字符串 | true | 唯一的 24-十六进制数字字符串，用于标识包含项目的组织。 使用 [/orgs](# 标签/Organizations/operation/listOrganizations) 端点检索身份验证的用户有权访问权限的所有组织。 |
--output | 字符串 | false | 首选API格式，可以是 ["JSON", go-template] 此值默认为 "JSON"。 |
--output-file | 字符串 | false | 要将API输出写入其中的文件。 当端点的输出为二进制（例如：gzip）且命令未通过管道传输（例如： Atlas command > out.zip）时，需要使用此标志 |
--pageNum | int | false | 显示响应返回的当前总对象集的页面编号。 |
--pretty | false | 指示响应正文是否应位于 <a href=" https://en.wikipedia.org/wiki/Prettyprint "target="_blank" rel="noopener noreferrer">pretty-print</a> 格式。 | |
--version | 字符串 | false | 进行API调用时要使用的API版本 [选项："2023-01-01"]，默认为最新版本或配置文件 api_version 配置值（如果设立了此值），默认为 "2023-01-01"。 |
继承选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
-P, --profile | 字符串 | false | 要从您的配置文件中使用的配置文件的名称。要学习；了解Atlas CLI配置文件，请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
示例
运行以下命令。
atlas api events listOrganizationEvents --version 2023-01-01 --envelope false --includeCount true --itemsPerPage 100 --orgId 4888442a3354817a7320eb61 --pageNum 1 --pretty false