返回所有建议的索引
返回性能优化顾问建议的索引。性能优化顾问会监控 MongoDB 认为其速度缓慢的查询，并建议使用新索引来提高查询性能。要使用此资源，请求的服务账户或 API 密钥必须具有“项目只读”角色。
路径参数
-
用于标识项目的唯一 24-十六进制数字字符串。 使用 /groups 端点检索身份验证的用户有权访问权限的所有项目。
注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。
格式应符合以下模式：
^([a-f0-9]{24})$。 -
用于标识集群的人类可读标签。
格式应符合以下模式：
^[a-zA-Z0-9][a-zA-Z0-9-]*$。
查询参数
-
从中检索建议索引的 processIds。processId 是服务于 MongoDB 进程的主机和端口的组合。主机名、FQDN、IPv4 地址或 IPv6 地址必须指向运行 MongoDB 进程（
mongod或mongos）的主机。该端口必须是 MongoDB 进程侦听请求的 IANA 端口。要包含多个 processId，请多次传递该参数，并在每个 processId 之间用符号 (&) 分隔。每个的格式应符合以下模式：
^([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})$。 -
从中检索建议索引的命名空间。命名空间由一个数据库和一个集合资源组成，写作
.:<database>.<collection>。要包含多个命名空间，请多次传递该参数，并在每个命名空间之间用与号 (&) 分隔。省略此参数可返回所有命名空间的结果。 -
查询检索建议索引的日期和时间。该参数以自 UNIX 纪元以来经过的毫秒数表示其值。
- 如果未指定 until 参数，端点将返回包含 since 值和当前时间的数据。
- 如果您既不指定 since 也不指定 until 参数，该端点将返回过去 24 小时的数据。
最小值为
1199145600000。 -
查询检索建议索引的结束日期和时间。该参数以自 UNIX 纪元以来经过的毫秒数表示其值。
- 如果指定 until 参数，则必须指定 since 参数。
- 如果您既不指定 since 也不指定 until 参数，该端点将返回过去 24 小时的数据。
最小值为
1199145600000。
atlas api performanceAdvisor listGroupClusterPerformanceAdvisorSuggestedIndexes --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20241113001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.ListGroupClusterPerformanceAdvisorSuggestedIndexesApiParams{}
sdkResp, httpResp, err := client.PerformanceAdvisorApi.
ListGroupClusterPerformanceAdvisorSuggestedIndexesWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2024-11-13+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/suggestedIndexes?pretty=true"curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2024-11-13+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/suggestedIndexes?pretty=true"{
"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
}
]
}{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}{
"error": 429,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Too Many Requests",
"errorCode": "RATE_LIMITED"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}