公共预览版:请提供反馈:返回压缩 (.gz)日志文件,其中包含指定项目的指定托管的范围日志消息。
公共预览版: Atlas API子命令从MongoDB Atlas Admin API自动生成,全面覆盖 Admin API ,目前处于公共预览版(请通过以下网址提供反馈:https://反馈.mongodb.com/forums/930808-Atlas-cli)。Admin API功能有自己的发布生命周期,您可以通过提供的API端点文档链接进行检查。
MongoDB每五分钟更新一次集群后端基础架构的进程和Atlas 审核日志。日志以长度约为五分钟的数据段存储,但此持续时间可能会有所不同。如果您轮询API的日志文件,我们建议每五分钟轮询一次,即使连续轮询可能包含一些重叠的日志。此功能不适用于 M0 免费集群、M2、M5、Flex 或无服务器集群。要使用此资源,请求的服务帐户或API密钥必须具有项目数据访问只读角色或更高角色。该API不支持使用JSON响应模式直接调用。 您必须使用以下格式的接受标头来请求gzip 响应模式:“Accept: 应用程序/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-gethostlogs 。
有关更多信息和示例,请参阅上面链接的参考API文档。
语法
atlas api monitoringAndLogs getHostLogs [options]
选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
--endDate | int | false | 指定要检索的日志消息范围终点的日期和时间,单位为自 UNIX 纪元起经过的秒数。此值将默认为开始日期后 24 小时。如果还未指定开始日期,则该值将默认为请求的时间。 |
--envelope | envelope | false | 指示应用程序是否将响应包装在信封JSON对象中的标志。某些API客户端无法访问权限HTTP响应标头或状态代码。要修复此问题,请在查询中设立Envelope=true。返回结果列表的端点将结果对象用作信封。应用程序将状态参数添加到响应正文中。 |
--groupId | 字符串 | true | 用于标识项目的唯一 24-十六进制数字字符串。 使用 [/groups](# 标签/Projects/operation/listProjects) 端点检索身份验证的用户有权访问权限的所有项目。 注意:群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组,群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。 |
-h,--help | false | getHostLogs 帮助 | |
--hostName | 字符串 | true | 用户可读的标签,用于标识存储要下载的日志文件的主机。 |
--logName | 字符串 | true | 用户可读的标签,用于标识要返回的日志文件。要返回审核日志,请为指定项目启用数据库审核。 |
-o, --output | 字符串 | false | 首选API格式,可以是 ["gzip"]。此值默认为 "gzip"。 |
--outputFile | 字符串 | false | 要将API输出写入其中的文件。 当端点的输出为二进制(例如:gzip)且命令未通过管道传输(例如: Atlas command > out.zip)时,需要使用此标志 |
--startDate | int | false | 指定要检索的日志消息范围起点的日期和时间,单位为自 UNIX 纪元起经过的秒数。此值将默认为结束日期前 24 小时。如果还未指定结束日期,则该值将默认为请求的时间前 24 小时。 |
--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。 |
示例
atlas api monitoringAndLogs getHostLogs --version 2023-02-01 --endDate 1609545600 --groupId [your-project-id] --hostName [your-host-name] --logName mongodb --startDate 1609459200