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

Atlas API performanceAdvisor listClusterRecommendedIndexes

公共预览版:请提供反馈:返回Performance Advisor建议的索引。

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

性能优化顾问会监控 MongoDB 认为其速度缓慢的查询,并建议使用新索引来提高查询性能。要使用此资源,请求的服务帐户或 API 密钥必须具有“项目只读”角色。

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

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

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

--clusterName

字符串

true

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

--groupId

字符串

true

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

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

-h,--help

false

listClusterRecommendedIndexes 帮助

--namespaces

.

false

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

-o, --output

字符串

false

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

--outputFile

字符串

false

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

--processIds

mongod

false

要从中检索建议索引的 ProcessId。processId 是为MongoDB进程提供服务的托管和端口的组合。托管必须是运行MongoDB进程(mongod或 mongos)的托管的主机名、FQDN、IPv4解决或 IPv6解决。该端口必须是MongoDB进程侦听请求的 IANA 端口。要包含多个 processId,请多次传递参数,并在每个 processId 之间用 & 符号 (&) 分隔。

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

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

名称
类型
必需
说明

-P, --profile

字符串

false

要从您的配置文件中使用的配置文件的名称。要学习;了解Atlas CLI配置文件,请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

atlas api performanceAdvisor listClusterSuggestedIndexes --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8

后退

getManagedSlowMs

在此页面上