Docs Menu
Docs Home
/ /

atlas api performanceAdvisor listClusterSuggestedIndexes

Devuelve los índices que recomienda el Performance Advisor.

El subcomando del atlas api se genera automáticamente a partir de la API de administración de MongoDB Atlas y ofrece una cobertura total de la API de administración. Las capacidades de la API de administración tienen su propio ciclo de vida de lanzamiento, que puedes consultar a través del enlace a la documentación del endpoint de la API proporcionada.

El Performance Advisor supervisa las queries que MongoDB considera lentas y sugiere nuevos índices para mejorar el rendimiento de las queries. Para utilizar este recurso, la cuenta de servicio o la clave de API que realiza la solicitud debe tener el rol Solo lectura del proyecto.

Este comando se genera automáticamente y corresponde 1:1 con el endpoint de la API de Atlas https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclusterperformanceadvisorsuggestedindexes.

Para obtener más información y ejemplos, consulta la documentación de la API referenciada que se encuentra en el enlace anterior.

Sintaxis del comando
atlas api performanceAdvisor listClusterSuggestedIndexes [options]
Nombre
Tipo
Requerido
Descripción

--clusterName

string

true

Etiqueta legible por humanos que identifica el clúster.

--groupId

string

true

string hexadecimal única de 24dígitos que identifica tu proyecto. Utiliza el punto final [/groups](#tag/Projects/operation/listProjects) 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 id de tu proyecto. Para los grupos ya existentes, el id de su grupo/proyecto sigue siendo el mismo. El recurso y los endpoints correspondientes utilizan el término grupos.

-h, --help

false

Ayuda para ListClusterSuggestedIndexes

--namespaces

.

false

Espacios de nombres de los cuales recuperar los índices sugeridos. Un namespace consta de una base de datos y un recurso de colección escrito como .: <database>.<collection>. Para incluir varios espacios de nombres, pase el parámetro varias veces delimitado con un ampersand (&) entre cada espacio de nombres. Omita este parámetro para devolver resultados de todos los espacios de nombres.

-o, --output

string

false

formato API preferido, puede ser ["JSON", plantilla-go] Este valor por defecto es "JSON".

--outputFile

string

false

archivo para guardar la salida de la api. Este flag es necesario cuando la salida de un endpoint es binaria (ej.: gzip) y el comando no se redirige (ej.: comando atlas > out.zip)

--processIds

mongod

false

ProcessIds desde los cuales recuperar índices sugeridos. Un processId es una combinación de host y puerto que sirve para el proceso MongoDB. El host debe ser el nombre, el FQDN, la dirección IPv4 o la dirección IPv6 del host que ejecuta el proceso MongoDB (mongod o mongos). El puerto debe ser el puerto IANA en el que el proceso de MongoDB escucha solicitudes. Para incluir varios processIds, pasa el parámetro varias veces separado por un ampersand (&) entre cada processId.

--since

Int

false

Fecha y hora a partir de las que la query recupera los índices sugeridos. Este parámetro expresa su valor en el número de milisegundos transcurridos desde la [Unix epoch](https://en.wikipedia.org/wiki/Unix_time).

  • Si no se especifica el parámetro hasta, el endpoint devuelve datos que cubren desde el valor desde hasta el momento actual.

  • Si no especificas los parámetros since o until, el endpoint devuelve datos de las 24 horas anteriores.

--until

Int

false

Fecha y hora hasta las cuales la query recupera los índices sugeridos. Este parámetro expresa su valor en el número de milisegundos que han transcurrido desde la [Unix epoch](https://en.wikipedia.org/wiki/Unix_time).

  • Si especifica el parámetro hasta, debe especificar el parámetro desde.

  • Si no especificas los parámetros since o until, el endpoint devuelve datos de las 24 horas anteriores.

--versión

string

false

versión de la API que se utilizará al llamar a la llamada de API [opciones: "2024-08-05"], por defecto se usa la versión más reciente o el valor de configuración api_version de perfiles si se establece Este valor por defecto es "2024-08-05".

Nombre
Tipo
Requerido
Descripción

-P, --profile

string

false

Nombre del perfil a usar de tu archivo de configuración. Para aprender sobre los perfiles para Atlas CLI, consulta https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

atlas api performanceAdvisor listClusterSuggestedIndexes --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8

Volver

obtenerManagedSlowMs

En esta página