Retornar todos os índices sugeridos para descarte

OBTER /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions

Retorna os índices que o Performance Advisor sugere descartar. O Performance Advisor sugere eliminar índices não utilizados, redundantes e ocultos para melhorar o desempenho de gravação e aumentar o espaço de armazenamento. 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

  • groupId string Obrigatório

    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})$.

  • clusterName string Obrigatório

    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-]*$.

Respostas

  • 200 application/vnd.atlas.2024-08-05+json

    OK

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • hiddenIndexes array[objeto]

      Lista que contém os documentos com informações sobre os índices ocultos que o Performance Advisor sugere remover.

      Hide hiddenIndexes attributes Mostrar atributos ocultoIndexes objeto
      • accessCount integer(int64)

        Contagem de uso (desde a última reinicialização) do índice.

      • index array[objeto]

        Lista que contém documentos que especificam uma chave no índice e sua ordem de classificação.

        Uma chave de índice emparelhada com sua ordem de classificação. Um valor de 1 indica uma ordem de classificação crescente. Um valor de -1 indica uma ordem de classificação decrescente. As chaves em índices com múltiplas chaves aparecem na mesma ordem em que aparecem no índice.

        Uma chave de índice emparelhada com sua ordem de classificação. Um valor de 1 indica uma ordem de classificação crescente. Um valor de -1 indica uma ordem de classificação decrescente. As chaves em índices com múltiplas chaves aparecem na mesma ordem em que aparecem no índice.

      • name string

        Nome do índice.

      • namespace string

        Rótulo legível por humanos que identifica o namespace no host especificado. O recurso expressa este valor de parâmetro como <database>.<collection>.

      • shards array[string]

        Lista que contém strings que especifica os fragmentos onde o índice é encontrado.

      • desde string(data-hora)

        Data do uso mais recente do índice. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

      • sizeBytes integer(int64)

        Tamanho do índice.

    • redundantIndexes array[objeto]

      Lista que contém os documentos com informações sobre os índices redundantes que o Performance Advisor sugere remover.

      Hide redundantIndexes attributes Mostrar atributos redundantIndexes objeto
      • accessCount integer(int64)

        Contagem de uso (desde a última reinicialização) do índice.

      • index array[objeto]

        Lista que contém documentos que especificam uma chave no índice e sua ordem de classificação.

        Uma chave de índice emparelhada com sua ordem de classificação. Um valor de 1 indica uma ordem de classificação crescente. Um valor de -1 indica uma ordem de classificação decrescente. As chaves em índices com múltiplas chaves aparecem na mesma ordem em que aparecem no índice.

        Uma chave de índice emparelhada com sua ordem de classificação. Um valor de 1 indica uma ordem de classificação crescente. Um valor de -1 indica uma ordem de classificação decrescente. As chaves em índices com múltiplas chaves aparecem na mesma ordem em que aparecem no índice.

      • name string

        Nome do índice.

      • namespace string

        Rótulo legível por humanos que identifica o namespace no host especificado. O recurso expressa este valor de parâmetro como <database>.<collection>.

      • shards array[string]

        Lista que contém strings que especifica os fragmentos onde o índice é encontrado.

      • desde string(data-hora)

        Data do uso mais recente do índice. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

      • sizeBytes integer(int64)

        Tamanho do índice.

    • unusedIndexes array[objeto]

      Lista que contém os documentos com informações sobre os índices não utilizados que o Performance Advisor sugere remover.

      Ocultar atributos não utilizadosIndexes Mostrar atributos utilizadosIndexes objeto
      • accessCount integer(int64)

        Contagem de uso (desde a última reinicialização) do índice.

      • index array[objeto]

        Lista que contém documentos que especificam uma chave no índice e sua ordem de classificação.

        Uma chave de índice emparelhada com sua ordem de classificação. Um valor de 1 indica uma ordem de classificação crescente. Um valor de -1 indica uma ordem de classificação decrescente. As chaves em índices com múltiplas chaves aparecem na mesma ordem em que aparecem no índice.

        Uma chave de índice emparelhada com sua ordem de classificação. Um valor de 1 indica uma ordem de classificação crescente. Um valor de -1 indica uma ordem de classificação decrescente. As chaves em índices com múltiplas chaves aparecem na mesma ordem em que aparecem no índice.

      • name string

        Nome do índice.

      • namespace string

        Rótulo legível por humanos que identifica o namespace no host especificado. O recurso expressa este valor de parâmetro como <database>.<collection>.

      • shards array[string]

        Lista que contém strings que especifica os fragmentos onde o índice é encontrado.

      • desde string(data-hora)

        Data do uso mais recente do índice. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

      • sizeBytes integer(int64)

        Tamanho do índice.

  • 400 aplicação/json

    Solicitação inválida.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 401 aplicação/json

    Não autorizado.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 403 aplicação/json

    Forbidden.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 404 aplicação/json

    Não encontrado.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 429 aplicação/json

    Muitas solicitações.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 500 aplicação/json

    Erro interno do servidor.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

GET /API/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions
atlas api performanceAdvisor listGroupClusterPerformanceAdvisorDropIndexSuggestions --help
import (
	"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.ListGroupClusterPerformanceAdvisorDropIndexSuggestionsApiParams{}
	sdkResp, httpResp, err := client.PerformanceAdvisorApi.
		ListGroupClusterPerformanceAdvisorDropIndexSuggestionsWithParams(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/dropIndexSuggestions?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/dropIndexSuggestions?pretty=true"
Exemplos de resposta (200)
{
  "hiddenIndexes": [
    {
      "accessCount": 42,
      "index": [
        {}
      ],
      "name": "string",
      "namespace": "string",
      "shards": [
        "string"
      ],
      "since": "2025-05-04T09:42:00Z",
      "sizeBytes": 42
    }
  ],
  "redundantIndexes": [
    {
      "accessCount": 42,
      "index": [
        {}
      ],
      "name": "string",
      "namespace": "string",
      "shards": [
        "string"
      ],
      "since": "2025-05-04T09:42:00Z",
      "sizeBytes": 42
    }
  ],
  "unusedIndexes": [
    {
      "accessCount": 42,
      "index": [
        {}
      ],
      "name": "string",
      "namespace": "string",
      "shards": [
        "string"
      ],
      "since": "2025-05-04T09:42:00Z",
      "sizeBytes": 42
    }
  ]
}
Exemplos de resposta (400)
{
  "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"
}
Exemplos de resposta (401)
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
Exemplos de resposta (403)
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
Exemplos de resposta (404)
{
  "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"
}
Exemplos de resposta (429)
{
  "error": 429,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Too Many Requests",
  "errorCode": "RATE_LIMITED"
}
Exemplos de resposta (500)
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}