Retornar todos os índices sugeridos
Retorna os índices sugeridos pelo Performance Advisor. O Performance Advisor monitora as queries que o MongoDB considera lentas e sugere novos índices para melhorar o desempenho das queries. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função somente leitura do projeto.
parâmetros de caminho
-
Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso.
AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos.
O formato deve corresponder ao seguinte padrão:
^([a-f0-9]{24})$. -
Etiqueta legível por humanos que identifica o cluster.
O formato deve corresponder ao seguinte padrão:
^[a-zA-Z0-9][a-zA-Z0-9-]*$.
parâmetros de query
-
ProcessIds dos quais recuperar índices sugeridos. Um processId é uma combinação de host e porta que atende ao processo do MongoDB. O host deve ser o nome do host, FQDM, endereço IPv4 ou endereço IPv6 do host que executa o processo MongoDB (
mongodoumongos). A porta deve ser a porta IANA na qual o processo do MongoDB escuta as solicitações. Para incluir vários processIds, passe o parâmetro várias vezes delimitado com um e comercial (&) entre cada processId.O formato de cada um deve corresponder ao seguinte padrão:
^([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})$. -
Namespaces dos quais recuperar índices sugeridos. Um namespace consiste em um banco de dados e um recurso de coleção escrito como
.:<database>.<collection>. Para incluir vários namespaces, passe o parâmetro várias vezes, delimitados por um ampersand (&) entre cada namespace. Omita este parâmetro para retornar resultados de todos os namespaces. -
Data e hora a partir das quais a query recupera os índices sugeridos. Esse parâmetro expressa seu valor no número de milissegundos decorridos desde a Era UNIX.
- Se você não especificar o parâmetro until, o endpoint retornará os dados que abrangem o valor since e a hora atual.
- Se você não especificar nem os parâmetros desde nem até, o ponto de extremidade retornará dados das 24 horas anteriores.
O valor mínimo é
1199145600000. -
Data e hora até as quais a consulta recupera os índices sugeridos. Esse parâmetro expressa seu valor no número de milissegundos decorridos desde a Era UNIX.
- Se você especificar o parâmetro until, deverá especificar o parâmetro since.
- Se você não especificar nem os parâmetros desde nem até, o ponto de extremidade retornará dados das 24 horas anteriores.
O valor mínimo é
1199145600000.
atlas api performanceAdvisor listGroupClusterPerformanceAdvisorSuggestedIndexes --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20250312001/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.2025-03-12+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.2025-03-12+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"
}