Devuelve las mediciones de un disco o partición para el host especificado para el proyecto determinado.
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 valor devuelto puede ser uno de los siguientes:
Rendimiento de las operaciones de E/S para la partición de disco utilizada para el proceso MongoDB
Porcentaje de tiempo durante el cual las solicitudes que la partición emitió y atendió
Latencia por tipo de operación de la partición de disco utilizada para el proceso de MongoDB
Cantidad de espacio en disco libre y utilizado en la partición de disco utilizada para el proceso de MongoDB
Para utilizar este recurso, la cuenta de servicio o clave de API que lo solicita debe tener el rol de 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/operación/operación-getgroupprocessdiskmeasurements.
Para obtener más información y ejemplos, consulta la documentación de la API referenciada que se encuentra en el enlace anterior.
Sintaxis
atlas api monitoringAndLogs getProcessDiskMeasurements [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--end | string | false | Fecha y hora en que MongoDB Cloud deja de reportar las métricas. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC. Incluye este parámetro cuando no establezcas period. |
--envelope | envelope | 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 sobre las métricas. Este parámetro expresa su valor en formato de duración ISO 8601 en UTC. |
--groupId | 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 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 getProcessDiskMeasurements | |
--m | m | false | Uno o más tipos de medición para solicitar para este proceso de MongoDB. Si se omite, el recurso devuelve todas las mediciones. Para especificar varios valores para m, repita el |
-o, --output | string | false | formato de API preferido, puede ser ["json", go-template] Este valor predeterminado 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) |
--partitionName | string | true | Etiqueta legible por humanos del disco o partición al que se aplican las mediciones. |
--period | string | false | Duración durante la cual Atlas informa las métricas. Este parámetro expresa su valor en el formato de duración ISO 8601 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 el formato prettyprint. | |
--processId | mongod | true | Combinación del nombre de host y el puerto de la Autoridad de Números Asignados en Internet (IANA) que sirve al proceso MongoDB. El host debe ser el nombre del host, el nombre de dominio completo (FQDN) o la dirección del Protocolo de Internet (IPv4 o IPv6) del host que ejecuta el proceso de 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 formato de marca de tiempo ISO 8601 en UTC. Incluya este parámetro si no define un período. |
--versión | string | false | versión de la API que se utilizará al llamar a la llamada de API [opciones: "2023-01-01"], 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 "2023-01-01". |
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 monitoringAndLogs getProcessDiskMeasurements --version 2023-01-01 --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --partitionName [partitionName] --period PT10H --processId mongodb.example.com:27017