Devuelve la serie de datos de métricas Atlas Search dentro del rango de tiempo proporcionado para un namespace y nombre de índice en el proceso especificado. Debe tener el rol de solo lectura de proyecto o uno superior para visualizar los tipos de métricas de Atlas Search.
Parámetros de path
-
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 IPv4 o IPv6 del host que ejecuta el proceso MongoDB (mongod o mongos). El puerto debe ser el puerto IANA en el que el proceso MongoDB recibe las solicitudes.
El formato debe coincidir con el siguiente patrón:
^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?(\:[0-9]{4,5})$. -
Etiqueta legible por humanos que identifica el índice.
-
Etiqueta legible por humanos que identifica la base de datos.
-
Etiqueta legible por humanos que identifica la colección.
-
string única de 24dígitos hexadecimales que identifica tu proyecto. Usa el endpoint /groups 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.
El formato debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$.
Parámetros de query
-
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.
-
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.
-
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.
-
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.
-
Bandera que indica si la aplicación envuelve la respuesta en un objeto JSON
envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para remediar esto, establece envelope=true en la query. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como un sobre. La aplicación agrega el parámetro de estado al cuerpo de la respuesta.El valor por defecto es
false. -
Lista que contiene las mediciones que MongoDB Atlas informa para la serie de datos asociada.
No más de
10elementos. Los valores sonINDEX_SIZE_ON_DISK,NUMBER_OF_DELETES,NUMBER_OF_ERROR_QUERIES,NUMBER_OF_GETMORE_COMMANDS,NUMBER_OF_INDEX_FIELDS,NUMBER_OF_INSERTS,NUMBER_OF_SUCCESS_QUERIES,NUMBER_OF_UPDATES,REPLICATION_LAGoTOTAL_NUMBER_OF_QUERIES.
curl \
--request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/hosts/my.host.name.com:27017/fts/metrics/indexes/mydb/mycoll/myindex/measurements?granularity=PT1M&metrics=INDEX_SIZE_ON_DISK' \
--header "Authorization: Bearer $ACCESS_TOKEN"{
"collectionName": "string",
"databaseName": "string",
"end": "2026-05-04T09:42:00Z",
"granularity": "PT1M",
"groupId": "32b6e34b3d91647abb20e7b8",
"indexIds": [
"string"
],
"indexStatsMeasurements": [
{
"dataPoints": [
{
"timestamp": "2026-05-04T09:42:00Z",
"value": 42.0
}
],
"name": "string",
"units": "BYTES"
}
],
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"processId": "mongodb.example.com:27017",
"start": "2026-05-04T09:42:00Z"
}{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}{
"error": 429,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Too Many Requests",
"errorCode": "RATE_LIMITED"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}