公共预览版：请在以下位置提供反馈：获取给定命名空间的 Coll Stats 延迟集群级测量值列表。
此命令是自动生成的，对应于 1:1 和Atlas API端点 https://www.mongodb.com/zh-cn/docs/atlas/reference/api-resources-spec/v2/#标签/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceClusterMeasurements。
有关更多信息和示例，请参阅上面链接的参考API文档。
语法
atlas api collectionLevelMetrics getCollStatsLatencyNamespaceClusterMeasurements [options]
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
--clusterName | 字符串 | true | 人类可读标签，用于标识要检索其指标的集群。 |
--clusterView | 字符串 | true | 人类可读标签，用于标识要检索其指标的集群拓扑结构。 |
--collectionName | 字符串 | true | 用于标识集合的用户可读标签。 |
--databaseName | 字符串 | true | 用于标识数据库的人类可读标签。 |
--end | 字符串 | false | MongoDB Cloud 停止报告指标的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。未设置周期时，请包含此参数。 |
--envelope | envelope | false | 指示应用程序是否将响应包装在信封JSON对象中的标志。某些API客户端无法访问权限HTTP响应标头或状态代码。要修复此问题，请在查询中设立Envelope=true。返回结果列表的端点将结果对象用作信封。应用程序将状态参数添加到响应正文中。 |
--groupId | 字符串 | true | 用于标识项目的唯一 24-十六进制数字字符串。 使用 [/groups](# 标签/Projects/operation/listProjects) 端点检索身份验证的用户有权访问权限的所有项目。 注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。 |
-h，--help | false | getCollStatsLatencyNamespaceClusterMeasurements 帮助 | |
--metrics | 字符串数组 | false | 包含您希望为关联数据系列检索的指标的列表。如果您未设置此参数，则此资源将返回所有集合延迟统计指标的数据序列。 |
--output | 字符串 | false | 首选API格式，可以是 ["JSON", go-template] 此值默认为 "JSON"。 |
--output-file | 字符串 | false | 要将API输出写入其中的文件。 当端点的输出为二进制（例如：gzip）且命令未通过管道传输（例如： Atlas command > out.zip）时，需要使用此标志 |
--period | 字符串 | false | Atlas 报告指标的持续时间。此参数以 UTC 格式的 ISO 8601 持续时间格式表示其值。在未设置开始和结束时包含此参数。 |
--start | 字符串 | false | MongoDB Cloud 开始报告指标的日期和时间。此参数以 UTC 格式的 ISO 8601 时间戳表示其值。未设置周期时，请包含此参数。 |
--version | 字符串 | false | 进行API调用时要使用的API版本 [选项："2023-11-15"]，默认为最新版本或配置文件 api_version 配置值（如果设立了此值），默认为 "2023-11-15"。 |
继承选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
-P, --profile | 字符串 | false | 要从您的配置文件中使用的配置文件的名称。要学习；了解Atlas CLI配置文件，请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |
示例
运行以下命令。
atlas api collectionLevelMetrics getCollStatsLatencyNamespaceClusterMeasurements --version 2023-11-15 --clusterName [clusterName] --clusterView [clusterView] --collectionName mycoll --databaseName mydb --envelope false --groupId 32b6e34b3d91647abb20e7b8 --period PT10H