Devuelve las mediciones de una base de datos para el host especificado para el proyecto especificado.
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.
Devuelve el espacio de almacenamiento en disco de la base de datos según la salida del comando dbStats de MongoDB. Para calcular algunas series de métricas, Atlas toma la tasa entre dos puntos adyacentes. Para estas series de métricas, el primer punto de datos tiene un valor nulo porque Atlas no puede calcular una tasa para el primer punto de datos dado el intervalo de tiempo de la consulta. Atlas recupera las métricas de la base de datos cada 20 minutos, pero reduce la frecuencia cuando es necesario para optimizar el rendimiento de la base de datos. Para usar este recurso, la cuenta de servicio o la clave API solicitantes deben 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-getgroupprocessdatabasemeasurements.
Para obtener más información y ejemplos, consulte la documentación de la API referenciada en el enlace anterior.
Sintaxis
atlas api monitoringAndLogs getDatabaseMeasurements [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--databaseName | string | true | Etiqueta legible por humanos que identifica la base de datos a la que sirve el proceso MongoDB especificado. |
--end | string | false | Fecha y hora en que MongoDB Cloud deja de reportar las métricas. Este parámetro expresa su valor en el 8601 formato de marca de tiempo ISO en UTC. Incluya este parámetro si no define un período. |
--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. |
--granularity | string | true | Duración que especifica el intervalo en el que Atlas informa las métricas. Este parámetro expresa su valor en el formato de duración ISO 8601 en UTC. |
--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 obtenerMedidas de Base de Datos | |
--m | m | false | Se solicitan uno o más tipos de medición para este proceso de MongoDB. Si se omite, el recurso devuelve todas las mediciones. Para especificar varios valores para m, repita el procedimiento. |
-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) |
--period | string | false | Duración durante la cual Atlas informa las métricas. Este parámetro expresa su valor en el 8601 formato de duración ISO en UTC. Incluya este parámetro si no establece el inicio ni el fin. |
--bonito | false | Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint. | |
--Identificador del proceso | mongod | true | Combinación de nombre de host y puerto de la Autoridad de Números Asignados de Internet (IANA) que sirve al proceso MongoDB. El host debe ser el nombre de host, el nombre de dominio completo (FQDN) o la dirección IPv4 o IPv6 del host que ejecuta el proceso MongoDB (mongod o |
--start | string | false | Fecha y hora en que MongoDB Cloud comienza a reportar las métricas. Este parámetro expresa su valor en el 8601 formato de marca de tiempo ISO en UTC. Incluya este parámetro si no define un período. |
--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". |
Opciones heredadas
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. |
Ejemplos
atlas api monitoringAndLogs getDatabaseMeasurements --version 2023-01-01 --databaseName [databaseName] --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --period PT10H --processId mongodb.example.com:27017