Para agentes de IA: hay un índice de documentación disponible en https://www.mongodb.com/es/docs/llms.txt — versiones en markdown de todas las páginas están disponibles agregando .md a cualquier ruta URL.

Atlas API ShardingInsights getShardMetricMeasurements

Devuelve series temporales de las mediciones solicitadas para un fragmento del clúster fragmentado 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.

La serie promedia las lecturas de los procesos miembros del fragmento seleccionados por nodeType. Responde con un 404 solo cuando no existe ningún fragmento con el replicaSetName dado en el clúster; un fragmento que existe pero no tiene lecturas pero devuelve una serie de puntos de datos nulos. Cada serie lleva un punto de datos por intervalo de granularidad, comenzando en inicio y no pasando por el final. El valor de un punto de datos es nulo cuando MongoDB Cloud no tiene lectura para ese intervalo; esto incluye los primeros minutos después de que se crea un clúster o fragmento, antes de recopilar sus métricas, por lo que nulo no debe leerse como carga cero. Establecer periodo, o establecer ambos inicio y fin; cuando ninguno está establecido, la respuesta cubre la última hora. Se rechaza una solicitud cuya ventana y granularidad producirían más de 1000 puntos de datos por serie.

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

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

Sintaxis del comando

atlas api shardingInsights getShardMetricMeasurements [options]
Nombre
Tipo
Requerido
Descripción

--clusterName

string

true

Etiqueta legible por humanos que identifica el clúster.

--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

false

Intervalo entre puntos de datos consecutivos, en formato ISO 8601 duración. Si se omite, MongoDB Cloud elige la resolución del ancho de la ventana.

--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 getShardMetricMeasurements

--m

m

false

Una o más mediciones para devolver. Si se omite, el recurso devuelve todas las mediciones. Para especificar múltiples valores para m, repita el parámetro m para cada valor.

--nodeType

string

false

Miembros del fragmento cuyas lecturas se promedian en la serie del fragmento.

-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.

--bastante

false

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

--replicaSetName

string

true

Etiqueta legible por humanos que identifica el fragmento, como el nombre de réplica del conjunto de sus miembros.

--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 debe usar al llamar a los endpoints de la API de Atlas [opciones: "2025-03-12"]. Si el usuario no lo configura, por defecto se utiliza la última versión o el valor de configuración api_version del perfil si se ha configurado. Este valor se establece por defecto en "2025-03-12".

Nombre
Tipo
Requerido
Descripción

-P, --profile

string

false

Nombre del perfil a usar de tu archivo de configuración. Para aprender sobre los perfiles para Atlas CLI, consulta https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

atlas api shardingInsights getShardMetricMeasurements --version 2025-03-12 --clusterName [clusterName] --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --period PT10H --replicaSetName atlas-12vorz-shard-0