Devolver todos los índices sugeridos para descartar

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

Devuelve los índices que el Asesor de Rendimiento sugiere eliminar. El Asesor de Rendimiento sugiere eliminar los índices no utilizados, redundantes y ocultos para mejorar el rendimiento de escritura y aumentar el espacio de almacenamiento. Para usar este recurso, la cuenta de servicio o la clave API solicitantes deben tener el rol de solo lectura del proyecto.

Parámetros de ruta

  • ID de grupo string Requerido

    Cadena 24hexadecimal única que identifica su proyecto. Utilice el punto de conexión /groups para recuperar todos los proyectos a los que el usuario autenticado tiene acceso.

    NOTA: Grupos y proyectos son términos sinónimos. El ID de tu grupo es el mismo que el de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. El recurso y los puntos finales correspondientes usan el término "grupos".

    El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

  • nombre del clúster string Requerido

    Etiqueta legible por humanos que identifica el clúster.

    El formato debe coincidir con el siguiente patrón: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.

Respuestas

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

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • hiddenIndexes matriz[objeto]

      Lista que contiene los documentos con información sobre los índices ocultos que el Asesor de Rendimiento sugiere eliminar.

      Hide hiddenIndexes attributes Mostrar atributos de hiddenIndexes Objeto
      • accesoCount integer(int64)

        Recuento de uso (desde el último reinicio) del índice.

      • index matriz[objeto]

        Lista que contiene documentos que especifican una clave en el índice y su orden de clasificación.

        Una clave de índice emparejada con su orden de ordenación. Un valor de 1 indica un orden de ordenación ascendente. Un valor de -1 indica un orden de ordenación descendente. Las claves en índices con varias claves aparecen en el mismo orden en que aparecen en el índice.

        Una clave de índice emparejada con su orden de ordenación. Un valor de 1 indica un orden de ordenación ascendente. Un valor de -1 indica un orden de ordenación descendente. Las claves en índices con varias claves aparecen en el mismo orden en que aparecen en el índice.

      • Nombre string

        Nombre del índice.

      • namespace string

        Etiqueta legible que identifica el espacio de nombres en el host especificado. El recurso expresa este valor de parámetro como <database>.<collection>.

      • shards array[string]

        Lista que contiene cadenas que especifican las particiones donde se encuentra el índice.

      • desde cadena(fecha-hora)

        Fecha del uso más reciente del índice. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

      • sizeBytes integer(int64)

        Tamaño del índice.

    • redundantIndexes matriz[objeto]

      Lista que contiene los documentos con información sobre los índices redundantes que el Asesor de Rendimiento sugiere eliminar.

      Hide redundantIndexes attributes Mostrar atributos redundantIndexes Objeto
      • accesoCount integer(int64)

        Recuento de uso (desde el último reinicio) del índice.

      • index matriz[objeto]

        Lista que contiene documentos que especifican una clave en el índice y su orden de clasificación.

        Una clave de índice emparejada con su orden de ordenación. Un valor de 1 indica un orden de ordenación ascendente. Un valor de -1 indica un orden de ordenación descendente. Las claves en índices con varias claves aparecen en el mismo orden en que aparecen en el índice.

        Una clave de índice emparejada con su orden de ordenación. Un valor de 1 indica un orden de ordenación ascendente. Un valor de -1 indica un orden de ordenación descendente. Las claves en índices con varias claves aparecen en el mismo orden en que aparecen en el índice.

      • Nombre string

        Nombre del índice.

      • namespace string

        Etiqueta legible que identifica el espacio de nombres en el host especificado. El recurso expresa este valor de parámetro como <database>.<collection>.

      • shards array[string]

        Lista que contiene cadenas que especifican las particiones donde se encuentra el índice.

      • desde cadena(fecha-hora)

        Fecha del uso más reciente del índice. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

      • sizeBytes integer(int64)

        Tamaño del índice.

    • unusedIndexes matriz[objeto]

      Lista que contiene los documentos con información sobre los índices no utilizados que el Asesor de Rendimiento sugiere eliminar.

      Ocultar atributos de unusedIndexes Mostrar atributos de unusedIndexes Objeto
      • accesoCount integer(int64)

        Recuento de uso (desde el último reinicio) del índice.

      • index matriz[objeto]

        Lista que contiene documentos que especifican una clave en el índice y su orden de clasificación.

        Una clave de índice emparejada con su orden de ordenación. Un valor de 1 indica un orden de ordenación ascendente. Un valor de -1 indica un orden de ordenación descendente. Las claves en índices con varias claves aparecen en el mismo orden en que aparecen en el índice.

        Una clave de índice emparejada con su orden de ordenación. Un valor de 1 indica un orden de ordenación ascendente. Un valor de -1 indica un orden de ordenación descendente. Las claves en índices con varias claves aparecen en el mismo orden en que aparecen en el índice.

      • Nombre string

        Nombre del índice.

      • namespace string

        Etiqueta legible que identifica el espacio de nombres en el host especificado. El recurso expresa este valor de parámetro como <database>.<collection>.

      • shards array[string]

        Lista que contiene cadenas que especifican las particiones donde se encuentra el índice.

      • desde cadena(fecha-hora)

        Fecha del uso más reciente del índice. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

      • sizeBytes integer(int64)

        Tamaño del índice.

  • 400 aplicación/json

    Solicitud incorrecta.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 401 aplicación/json

    No autorizado.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 403 aplicación/json

    Forbidden.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 404 aplicación/json

    No se encontró.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 429 aplicación/json

    Demasiadas solicitudes.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 500 aplicación/json

    Error Interno del Servidor.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

OBTENER /api/atlas/v2/grupos/{ID de grupo}/clústeres/{nombre del clúster}/performanceAdvisor/dropIndexSuggestions
atlas api performanceAdvisor listDropIndexSuggestions --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"
Ejemplos de respuestas (200)
{
  "hiddenIndexes": [
    {
      "accessCount": 42,
      "index": [
        {}
      ],
      "name": "string",
      "namespace": "string",
      "shards": [
        "string"
      ],
      "since": "2026-05-04T09:42:00Z",
      "sizeBytes": 42
    }
  ],
  "redundantIndexes": [
    {
      "accessCount": 42,
      "index": [
        {}
      ],
      "name": "string",
      "namespace": "string",
      "shards": [
        "string"
      ],
      "since": "2026-05-04T09:42:00Z",
      "sizeBytes": 42
    }
  ],
  "unusedIndexes": [
    {
      "accessCount": 42,
      "index": [
        {}
      ],
      "name": "string",
      "namespace": "string",
      "shards": [
        "string"
      ],
      "since": "2026-05-04T09:42:00Z",
      "sizeBytes": 42
    }
  ]
}
Ejemplos de respuestas (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"
}
Ejemplos de respuestas (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"
}
Ejemplos de respuestas (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"
}
Ejemplos de respuestas (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"
}
Ejemplos de respuestas (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"
}
Ejemplos de respuestas (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"
}