Vista previa pública: proporcione comentarios: devuelve las sugerencias de esquema que detecta el Asesor de rendimiento.
El subcomando de la API de Atlas, generado automáticamente a partir de la API de administración de MongoDB Atlas, ofrece cobertura total de la API de administración y actualmente se encuentra en Vista Previa Pública (por favor, proporciona comentarios en https://feedback.mongodb.com/forums/930808-atlas-cli). Las capacidades de la Admin API tienen su propio ciclo de vida de lanzamientos, que se puede consultar en el enlace de documentación del endpoint de API proporcionado.
El Performance Advisor brinda recomendaciones de esquema holísticas para tu clúster al realizar un muestreo de documentos en tus colecciones más activas y en colecciones con queries de ejecución lenta. Para usar este recurso, la Cuenta de servicio solicitante o la clave API debe tener el rol Solo lectura del proyecto.
Este comando se genera automáticamente y 1 corresponde:1 con el punto final de la API de Atlas https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operation/operation-listschemaadvice.
Para obtener más información y ejemplos, consulte la documentación de la API referenciada en el enlace anterior.
Sintaxis
atlas api performanceAdvisor listSchemaAdvice [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--clusterName | string | true | Etiqueta legible por humanos que identifica el clúster. |
--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 listSchemaAdvice | |
-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) |
--versión | string | false | Versión de API a utilizar al llamar a la llamada de API [opciones: "2024-08-05"], 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 "2024-08-05". |
Opciones heredadas
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-P, --profile | string | false | Nombre del perfil que se utilizará en tu archivo de configuración. Para aprender sobre los perfiles para el Atlas CLI, consulta https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Ejemplos
atlas api performanceAdvisor listSchemaAdvice --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8