返回性能优化顾问建议的索引。Performance Advisor 会监控 MongoDB 认为其速度缓慢的查询，并建议使用新索引来提高查询性能。
- 项目只读
路径参数
-
用于标识项目的唯一 24-十六进制数字字符串。 使用 /groups 端点检索身份验证的用户有权访问权限的所有项目。
注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。
格式应符合以下模式：
^([a-f0-9]{24})$。 -
为 MongoDB 进程提供服务的主机和端口的组合。主机必须是运行 MongoDB 进程（
mongod或mongos）的主机的主机名、FQDN、IPv4 地址或 IPv6 地址。该端口必须是 MongoDB 进程侦听请求的 IANA 端口。格式应符合以下模式：
^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?(\:[0-9]{4,5})$。
查询参数
-
指示应用程序是否将响应包装在
envelopeJSON 对象中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，请在查询中设置 Envelope=true。返回结果列表的端点将结果对象用作 envelope。应用程序将状态参数添加到响应正文中。默认值为
false。 -
指示响应是否返回响应中的列项总数 (
totalCount) 的标志。默认值为
true。 -
响应每页返回的列项数。
最小值为
1，最大值为500。默认值为100。 -
显示响应返回的当前总对象集的页面编号。
最小值为
1。默认值为1。 -
指示响应正文是否应采用 prettyprint 格式的标记。
默认值为
false。Prettyprint -
查询在集群的托管命名空间中查找建议索引的时间长度。此参数以毫秒为单位。
- 如果不指定 since 参数，则端点将返回涵盖当前时间之前持续时间的数据。
- 如果您既不指定 duration 也不指定 since 参数，该端点将返回过去 24 小时的数据。
-
从中检索建议索引的命名空间。命名空间由一个数据库和一个集合资源组成，写作
.:<database>.<collection>。要包含多个命名空间，请多次传递该参数，并在每个命名空间之间用与号 (&) 分隔。省略此参数可返回所有命名空间的结果。 -
从建议的索引中受益的示例查询的最大数量。
默认值为
5。 -
指示要建议的最大索引的数字。
-
查询检索建议索引的日期和时间。该参数以自 UNIX 纪元以来经过的毫秒数表示其值。
- 如果不指定持续时间参数，端点将返回从 since 值到当前时间的数据。
- 如果您既不指定 duration 也不指定 since 参数，该端点将返回过去 24 小时的数据。
最小值为
1199145600000。
curl \
--request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/processes/{processId}/performanceAdvisor/suggestedIndexes' \
--header "Authorization: Bearer $ACCESS_TOKEN"{
"shapes": [
{
"avgMs": 42,
"count": 42,
"id": "32b6e34b3d91647abb20e7b8",
"inefficiencyScore": 42,
"namespace": "string",
"operations": [
{
"predicates": [
{}
],
"stats": {
"ms": 42,
"nReturned": 42,
"nScanned": 42,
"ts": 42
}
}
]
}
],
"suggestedIndexes": [
{
"avgObjSize": 42.0,
"id": "32b6e34b3d91647abb20e7b8",
"impact": [
"string"
],
"index": [
{
"additionalProperty1": 1,
"additionalProperty2": 1
}
],
"namespace": "string",
"weight": 42.0
}
]
}{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 401,
"errorCode": "NOT_ORG_GROUP_CREATOR",
"reason": "Unauthorized"
}{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 403,
"errorCode": "CANNOT_CHANGE_GROUP_NAME",
"reason": "Forbidden"
}{
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"error": 404,
"errorCode": "RESOURCE_NOT_FOUND",
"reason": "Not Found"
}{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 429,
"errorCode": "RATE_LIMITED",
"reason": "Too Many Requests"
}{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 500,
"errorCode": "UNEXPECTED_ERROR",
"reason": "Internal Server Error"
}