下载指定 Atlas Streams Processing 实例的审核日志。
atlas api 子命令是从 MongoDB Atlas Admin API 自动生成的，并提供对 Admin API 的全面覆盖。Admin API功能有自己的发布生命周期，您可以通过提供的API终结点文档链接进行检查。
默认情况下，日志覆盖 30 天的时段。要使用此资源，请求的服务账户或 API 密钥必须具有项目数据访问角色、项目所有者角色或项目流处理所有者角色。该 API 不支持直接调用 JSON 响应模式。您必须使用以下格式的接受标头来请求 gzip 响应模式：“Accept: application/vnd.atlas.YYYY-MM-DD+gzip”。
此命令是自动生成的，对应 1:1 与 Atlas API 终结点 https://www.mongodb.com/zh-cn/docs/api/doc/atlas-admin-api-v2/operation/operation-downloadgroupstreamauditlogs.
有关更多信息和示例，请参阅上面链接的参考API文档。
语法
atlas api streams downloadAuditLogs [options]
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
--endDate | int | false | 指定要下载的日志消息范围终点的时间戳。MongoDB Cloud 以自 UNIX 纪元以来经过的秒数表示此时间戳。 |
--envelope | envelope | false | 指示应用程序是否将响应包装在信封JSON对象中的标志。某些API客户端无法访问权限HTTP响应标头或状态代码。要修复此问题，请在查询中设立Envelope=true。返回结果列表的端点将结果对象用作信封。应用程序将状态参数添加到响应正文中。 |
--groupId | 字符串 | true | 用于标识项目的唯一 24-十六进制数字字符串。 使用 [/groups](# 标签/Projects/operation/listProjects) 端点检索身份验证的用户有权访问权限的所有项目。 注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。 |
-h，--help | false | downloadAuditLogs 帮助 | |
-o, --output | 字符串 | false | 首选API格式，可以是 ["gzip"]。此值默认为 "gzip"。 |
--outputFile | 字符串 | false | 要将API输出写入其中的文件。 当端点的输出为二进制（例如：gzip）且命令未通过管道传输（例如： Atlas command > out.zip）时，需要使用此标志 |
--startDate | int | false | 指定要下载的日志消息范围起点的时间戳。MongoDB Cloud 以自 UNIX 纪元以来经过的秒数表示此时间戳。 |
--tenantName | 字符串 | true | 人类可读标签，用于标识流实例。 |
--version | 字符串 | false | 进行API调用时要使用的API版本 [选项："2023-02-01"]，默认为最新版本或配置文件 api_version 配置值（如果设立了此值），默认为 "2023-02-01"。 |
继承选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
-P, --profile | 字符串 | false | 要从您的配置文件中使用的配置文件的名称。要学习；了解Atlas CLI配置文件，请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |
示例
atlas api streams downloadAuditLogs --version 2023-02-01 --endDate 1.636481348e+09 --groupId 32b6e34b3d91647abb20e7b8 --startDate 1.636466948e+09 --tenantName [tenantName]