Docs Menu
Docs Home
/ /

lista de índices sugeridos de performance Advisor de la API de atlas

Devuelve los índices que sugiere el Asesor de rendimiento.

El subcomando atlas api se genera automáticamente desde la API de administración de MongoDB Atlas y ofrece cobertura completa de dicha API. Las capacidades de la API de administración tienen su propio ciclo de vida de lanzamiento, que puede consultar a través del enlace de documentación del punto final de la API.

El Asesor de Rendimiento supervisa las consultas que MongoDB considera lentas y sugiere nuevos índices para mejorar el rendimiento de las consultas. Para usar este recurso, la cuenta de servicio o la clave API solicitante debe tener el rol de solo lectura del proyecto.

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

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

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

--duration

Int

false

Tiempo durante el cual la consulta encuentra los índices sugeridos entre los espacios de nombres administrados del clúster. Este parámetro se expresa en milisegundos.

  • Si no especifica el parámetro since, el punto final devuelve datos que cubren la duración anterior a la hora actual.

  • Si no especifica los parámetros de duración ni desde, el punto final devuelve datos de las 24 horas anteriores.

--sobre

envolvente

false

Indicador que indica si la aplicación envuelve la respuesta en un objeto JSON tipo sobre. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como sobre. La aplicación añade el parámetro de estado al cuerpo de la respuesta.

--ID de grupo

string

true

Cadena única de dígitos hexadecimales 24que identifica su proyecto. Utilice el punto de conexión [/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 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".

-h, --ayuda

false

Ayuda para listSuggestedIndexes

--incluirConteo

false

Bandera que indica si la respuesta devuelve el número total de elementos (totalCount) en larespuesta.

--itemsPerPage

Int

false

Número de elementos que la respuesta devuelve por página.

--nExamples

Int

false

Número máximo de consultas de ejemplo que se benefician del índice sugerido.

--nIndexes

Int

false

Número que indica los índices máximos a sugerir.

--namespaces

.

false

Espacios de nombres desde los cuales se recuperan los índices sugeridos. Un espacio de nombres 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 por un símbolo & (&) entre cada espacio de nombres. Omita este parámetro para obtener resultados para todos los espacios de nombres.

-o, --output

string

false

formato de API preferido, puede ser ["json", go-template] Este valor predeterminado es "json".

--archivo de salida

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)

--Número de página

Int

false

Número de la página que muestra el conjunto actual del total de objetos que devuelve la respuesta.

--bonito

false

Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint.

--Identificador del proceso

mongod

true

Combinación de host y puerto que sirve al proceso MongoDB. El host debe ser el nombre de host, 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 MongoDB recibe solicitudes.

--since

Int

false

Fecha y hora a partir de las cuales la consulta recupera los índices sugeridos. Este parámetro expresa su valor en milisegundos transcurridos desde la [época UNIX](https://en.wikipedia.org/wiki/Unix_time).

  • Si no especifica el parámetro de duración, el punto final devuelve datos que abarcan desde el valor desde y la hora actual.

  • Si no especifica ni los parámetros de duración ni desde, el punto final devuelve datos de las 24 horas anteriores.

--versión

string

false

Versión de API a utilizar al llamar a la llamada de API [opciones: "2023-01-01"], el valor predeterminado es la última versión o el valor de configuración api_version de los perfiles si está configurado. Este valor predeterminado es "2023-01-01".

Nombre
Tipo
Requerido
Descripción

-P, --profile

string

false

Nombre del perfil que se usará en el archivo de configuración. Para obtener más información sobre los perfiles de la CLI de Atlas, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

atlas api performanceAdvisor listSuggestedIndexes --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --processId [processId]

Volver

listaSlowQueryLogs

En esta página