atlas api queryShapeInsights listQueryShapeSummaries

--clusterName

字符串

true

用于标识集群的人类可读标签。

--commands

和

false

检索与指定MongoDB命令匹配的查询结构统计信息。要包含多个命令，请多次传递参数，并在每个命令之间用与号 (&) 分隔。当前支持的参数包括 find、distinct 和aggregate。省略此参数可返回所有支持命令的结果。

--envelope

envelope

false

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

--groupId

字符串

true

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

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

-h，--help

false

listQueryShapeSummaries 帮助

--nSummaries

int

false

要返回的查询统计摘要的最大数量。

--namespaces

.

false

从中检索查询结构统计信息的命名空间。命名空间由一个数据库和一个集合资源组成，写作 .: <database>.<collection>。要包含多个命名空间，请多次传递该参数，并在每个命名空间之间用 & 符号 (&) 分隔。省略此参数可返回所有命名空间的结果。

-o, --output

字符串

false

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

--outputFile

字符串

false

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

--pretty

false

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

--processIds

processId

false

要从中检索查询结构统计信息的进程 ID。processId 是由托管和端口组成，用于为 MongoDB 进程提供服务。托管必须是运行MongoDB进程（mongod 或 mongos）的托管的主机名、FQDN、IPv4解决或 IPv6解决。该端口必须是MongoDB进程侦听请求的 IANA 端口。要包含多个 processId，请多次传递该参数，并在每个 processId 之间用与号 (&) 分隔。

--queryShapeHashes

$queryStats

false

所需查询结构的 SHA256 哈希列表，由 $queryStats 和 $explain 等MongoDB命令或慢查询日志输出。要包含多个系列，请多次传递该参数，并在每个系列之间用与号 (&) 分隔。省略此参数可返回所有可用系列的结果。

--series

和

false

查询结构统计数据系列以进行检索。系列表示有关查询执行的特定指标。要包含多个系列，请多次传递该参数，并在每个系列之间用与号 (&)分隔。省略此参数可返回所有可用系列的结果。P50_EXECUTION_TIME、P90_EXECUTION_TIME和P99_EXECUTION_TIME系列已弃用，因为它们报告的值可能不准确。它们将在未来版本中删除。

--since

int

false

检索检索查询结构统计信息的日期和时间。此参数以自 [UNIX 纪元](https://en.wikipedia.org/wiki/Unix_time) 以来经过的毫秒数表示其值。

• 如果未指定 until 参数，端点将返回包含 since 值和当前时间的数据。

• 如果您既不指定 since 也不指定 until 参数，该端点将返回过去 24 小时的数据。

--until

int

false

检索检索查询结构统计信息的截止日期和时间。此参数以自 [UNIX 纪元](https://en.wikipedia.org/wiki/Unix_time) 以来经过的毫秒数表示其值。

• 如果指定 until 参数，则必须指定 since 参数。

• 如果您既不指定 since 也不指定 until 参数，该端点将返回过去 24 小时的数据。

--version

字符串

false

调用 Atlas API 终结点时要使用的 API 版本 [选项："2025-03-12"]。如果用户未设置，则默认为最新版本，或者如果已设置了配置文件的 api_version 值，则默认为该值。此值默认为 "2025-03-12"。