Join us Sept 17 at .local NYC! Use code WEB50 to save 50% on tickets. Learn more >
MongoDB Event
Docs 菜单
Docs 主页
/ /
Atlas CLI
/ / / /

atlas api monitoringAndLogs getDatabaseMeasurements

公共预览版:请提供反馈:返回指定项目的指定托管的一个数据库的测量值。

公共预览版: Atlas API子命令从MongoDB Atlas Admin API自动生成,全面覆盖 Admin API ,目前处于公共预览版(请通过以下网址提供反馈:https://反馈.mongodb.com/forums/930808-Atlas-cli)。Admin API功能有自己的发布生命周期,您可以通过提供的API端点文档链接进行检查。

根据MongoDB dbStats 命令输出,返回数据库的磁盘上存储空间。为了计算某些指标系列, Atlas会计算每两个相邻点之间的比率。对于这些指标系列,第一个数据点具有 null 值,因为Atlas无法计算给定查询时间范围的第一个数据点的比率。Atlas每 20 分钟检索一次数据库指标,但会在必要时降低频率以优化数据库性能。要使用此资源,请求的服务帐户或API密钥必须具有“项目只读”角色。

1此命令是自动生成的,对应于:1 和Atlas API端点 https://www.mongodb.com/zh-cn/docs/api/doc/atlas-admin-api-v2 /operation/operation-getdatabasemeasurements 。

有关更多信息和示例,请参阅上面链接的参考API文档。

命令语法
atlas api monitoringAndLogs getDatabaseMeasurements [options]
名称
类型
必需
说明

--databaseName

字符串

true

用户可读标签,用于标识指定 MongoDB 进程所服务的数据库。

--end

字符串

false

MongoDB Cloud 停止报告指标的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。未设置周期时,请包含此参数。

--envelope

envelope

false

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

--granularity

字符串

true

持续时间,用于指定 Atlas 报告指标的时间间隔。此参数以 UTC 格式的 ISO 8601 持续时间格式表示其值。

--groupId

字符串

true

用于标识项目的唯一 24-十六进制数字字符串。 使用 [/groups](# 标签/Projects/operation/listProjects) 端点检索身份验证的用户有权访问权限的所有项目。

注意:群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组,群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。

-h,--help

false

getDatabaseMeasurements 帮助

--m

m

false

为此MongoDB进程请求的一种或多种类型的测量。如果省略,资源将返回所有测量值。要为 m 指定多个值,请为每个值重复使用 m 参数。指定应用于指定托管的测量值。如果您指定了任何无效的测量值, MongoDB Cloud 将返回错误。

-o, --output

字符串

false

首选API格式,可以是 ["JSON", go-template] 此值默认为 "JSON"。

--outputFile

字符串

false

要将API输出写入其中的文件。 当端点的输出为二进制(例如:gzip)且命令未通过管道传输(例如: Atlas command > out.zip)时,需要使用此标志

--period

字符串

false

Atlas 报告指标的持续时间。此参数以 UTC 格式的 ISO 8601 持续时间格式表示其值。在未设置开始结束时包含此参数。

--pretty

false

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

--processId

mongod

true

主机名和为MongoDB进程提供服务的互联网号码分配机构 (IANA) 端口的组合。托管必须是运行MongoDB进程(mongod或 mongos)的托管的主机名、完全限定域名 (FQDN) 或 Internet 协议解决(IPv4 或 IPv6)。该端口必须是MongoDB进程侦听请求的 IANA 端口。

--start

字符串

false

MongoDB Cloud 开始报告指标的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。未设置周期时,请包含此参数。

--version

字符串

false

进行API调用时要使用的API版本 [选项:"2023-01-01"],默认为最新版本或配置文件 api_version 配置值(如果设立了此值),默认为 "2023-01-01"。

名称
类型
必需
说明

-P, --profile

字符串

false

atlas api monitoringAndLogs getDatabaseMeasurements --version 2023-01-01 --databaseName [databaseName] --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --period PT10H --processId mongodb.example.com:27017

在此页面上