Devuelve la serie de datos de hardware y estado de Atlas Search dentro del rango de tiempo proporcionado para un proceso en el proyecto especificado.
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.
Debes tener el rol de Project Read Only o superior para ver los tipos de métricas de Atlas Search.
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/operation-listgrouphostftsmetricmeasurements.
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 listMeasurements [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 señala si la Aplicación envuelve la respuesta en un objeto JSON de envoltorio. Algunos clientes de API no pueden acceder a las cabeceras de respuesta HTTP o al código de estado. Para remediarlo, establece envelope=true en la query. 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 | 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 listMeasurements | |
--metrics | stringArray | true | Lista que contiene las métricas que quieres que MongoDB Atlas reporte para la serie de datos asociada. Si no establece este parámetro, este recurso devuelve todas las métricas de hardware y estado para las series de datos asociadas. |
-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) |
--period | string | false | Periodo durante el cual Atlas informa las métricas. Este parámetro expresa su valor en el formato de duración ISO 8601 en UTC. Este parámetro se incluye cuando no se establecen inicio y final. |
--processId | string | true | Combinación de nombre de host y puerto IANA que sirve al proceso MongoDB. El host debe ser el nombre de 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 mongos). El puerto debe ser el puerto IANA en el cual el proceso de MongoDB recibe las solicitudes. |
--start | string | false | Fecha y hora en que MongoDB Cloud comienza el reporte de métricas. Este parámetro expresa su valor en el formato de fecha y hora ISO 8601 en UTC. Este parámetro se incluye cuando no se establece 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 listMeasurements --version 2023-01-01 --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --metrics [metrics] --period PT10H --processId my.host.name.com:27017