MongoDB工具 >MongoDB命令行界面 >参考 >阿特拉斯 > 描述可用的测量
该命令列出了指定Atlas主机上指定分区的可用度量。您可以使用measurement disks list
命令获取主机的分区名称
列表。您可以使用process list命令获取与特定Atlas项目关联的主机名。measurements disks describe
注意
使用-h
或--help
查看此命令的命令行帮助。
选项 | 类型 | 描述 | 需要? | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
<hostname>:<port> |
串 | 运行Atlas MongoDB进程的服务器的主机名以及该进程侦听的端口。 | 是 | ||||||||
<partition-name> |
串 | 要获取其可用测量值的磁盘或分区的名称。 | 是 | ||||||||
granularity |
串 | ISO-8601格式的时间段,指定测量数据点之间的间隔。例如, 支持以下ISO-8601格式的时间段子集:
指定时 |
是 | ||||||||
period |
串 | ISO-8601格式的时间段,指定过去查询的时间长度。例如,要请求最近36小时,请指定:
period=P1DT12H 。与start 和互斥end 。 |
是 | ||||||||
start |
串 | 开始检索测量值的时间,由ISO-8601时间戳字符串指定。如果指定start ,则还必须指定end 。与互斥period 。 |
是 | ||||||||
end |
串 | 停止检索测量值的时间,由ISO-8601时间戳字符串指定。如果指定end ,则还必须指定start 。与互斥period 。 |
是 | ||||||||
type |
串 | 指定要返回的度量。如果 您必须指定对主机有效的度量。如果指定的测量值无效,则Atlas返回错误。 以下测量值有效:
|
没有 | ||||||||
--profile , -P |
串 | 用于保存项目ID和项目API的配置文件的名称。如果省略,则使用default 配置文件。要了解有关创建配置文件的更多信息,请参阅配置MongoDB CLI。 |
没有 | ||||||||
--projectId |
串 | 要为其检索事件的项目的唯一标识符。如果省略,则使用配置文件中列出的项目ID。 | 没有 |
如果命令成功,则该命令以JSON格式输出以下字段。如果命令显示错误,请参阅 故障排除以获取建议的解决方案。
免费套餐
M0
免费层和M2/M5
共享层集群返回此处记录的指标的子集。
如果将query元素设置envelope
为true
,则响应由content
对象包装。
HTTP响应返回一个包含以下对象的JSON文档:
名称 | 类型 | 描述 |
---|---|---|
end |
串 | 检索测量值的时间段的结束,指定为ISO-8601时间戳记。 |
granularity |
串 | ISO-8601格式的时间段,指定每个数据点所覆盖的间隔的大小。例如,PT5M 指定5分钟的粒度。 |
groupId |
串 | 拥有Atlas MongoDB流程的项目的ID。 |
hostId |
串 | 运行Atlas MongoDB进程的计算机的主机名。 |
links |
数组 | 文件数组,表示一个链接到一个或更多的子资源和/或相关的资源,如列表分页。有关更多信息,请参见链接。 |
measurements |
对象数组 | 一组测量值及其数据点。 |
measurements.name |
串 | 测量名称。 |
measurements.units |
串 | 测量如何量化。可能的单位是:
|
partitionName |
串 | 与测量有关的磁盘或分区的名称。 |
processId |
串 | 运行Atlas MongoDB进程的计算机的主机名和端口。 |
start |
串 | 检索测量值的时间段的开始,指定为ISO-8601时间戳记。 |
以下示例使用该命令检索ID为ID的主机上端口的可用分区的
可用过程度量,并在port上侦听。粒度设置为一分钟,时间为一分钟。该命令使用一个名为的配置文件,其中存储了项目ID和Programmatic API密钥。mongocli atlas measurements disks describe
data
atlas-ap6k8a-shard-00-02.qmljy.mongodb.net
27017
egAtlasProfile
上一条命令产生以下输出。