- 此版本的文档已存档,不再提供支持。 查看最新文档,学习;了解如何升级Atlas CLI版本。
实验性:返回压缩 (.gz)日志文件,其中包含指定项目的指定托管的范围日志消息。
MongoDB每五分钟更新一次集群后端基础架构的进程和Atlas 审核日志。日志以长度约为五分钟的数据段存储,但此持续时间可能会有所不同。如果您轮询API的日志文件,我们建议每五分钟轮询一次,即使连续轮询可能包含一些重叠的日志。此功能不适用于 M0 免费集群、M2、M5、Flex 或无服务器集群。要使用此资源,请求的API密钥必须具有“项目数据访问只读”或更高角色。该API不支持使用JSON响应模式直接调用。 您必须使用以下格式的接受标头来请求gzip 响应模式:“Accept: 应用程序/vnd.atlas.YYYY-MM-DD+gzip”。此命令正在调用 OperationID 为“getHostLogs”的端点。有关标志、文件格式和示例的更多信息,请参阅:https://www.mongodb.com/zh-cn/docs/atlas/reference/api-resources-spec/v2/#标签/Monitoring-and-Logs/operation/getHostLogs
语法
atlas api monitoringAndLogs getHostLogs [options]
选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
--endDate | int | false | 指定要检索的范围日志点的日期和时间,以自 UNIX 纪元以来经过的秒数表示 |
--envelope | false | 标志,指示应用程序是否将响应包装在信封JSON对象中 | |
--groupId | 字符串 | true | 用于标识项目的唯一 24-十六进制数字字符串 |
-h,--help | false | getHostLogs 帮助 | |
--hostName | 字符串 | true | 人类可读标签,用于标识存储要下载的日志文件的托管 |
--logName | 字符串 | true | 人类可读标签,用于标识要返回的日志文件 |
--output | 字符串 | false | 首选API格式,可以是 ["gzip"]。此值默认为 "gzip"。 |
--output-file | 字符串 | false | 要将API输出写入其中的文件。 当端点的输出为二进制(例如:gzip)且命令未通过管道传输(例如: Atlas command > out.zip)时,需要使用此标志 |
--startDate | int | false | 指定要检索的日志信息范围点的日期和时间,以自 UNIX 纪元起经过的秒数表示 |
--version | 字符串 | false | 进行API调用时要使用的API版本 [选项:"2023-01-01"、"2023-02-01"],默认为最新版本或配置文件 api_version配置值,如果设立此值,则默认为 "2023-02-01"。 |
继承选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
-P, --profile | 字符串 | false | 要从您的配置文件中使用的配置文件的名称。要学习;了解Atlas CLI配置文件,请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |