Docs 菜单
Docs 主页
/ /
Atlas CLI
/ / /

atlas api monitoringAndLogs getMeasurements

公开预览版:请提供反馈:返回指定项目中一个进程在提供的时间范围内的Atlas Search硬件和状态数据系列。

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

您必须具有“项目只读”或更高角色才能查看 Atlas Search 指标类型。

此命令是自动生成的,对应于 1:1 和Atlas API端点 https://www.mongodb.com/zh-cn/docs/atlas/reference/api-resources-spec/v2/#标签/Monitoring-and-Logs/operation/getMeasurements。

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

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

--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

getMeasurements 帮助

--metrics

字符串数组

true

包含您希望 MongoDB Atlas 报告关联数据系列的指标的列表。如果不设置此参数,该资源将返回相关数据系列的所有硬件和状态指标。

-o, --output

字符串

false

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

--outputFile

字符串

false

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

--period

字符串

false

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

--processId

字符串

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 getMeasurements --version 2023-01-01 --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --metrics [metrics] --period PT10H --processId my.host.name.com:27017

后退

getIndexMetrics

在此页面上