Mediciones de retorno para un proceso MongoDB

Obtener /api/atlas/v2/grupos/{ID_grupo}/procesos/{ID_proceso}/mediciones

Devuelve mediciones de disco, partición o host por proceso para el host especificado y el proyecto especificado. 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 se emitieron y atendieron las solicitudes de la partición
  • Latencia por tipo de operación de la partición de disco utilizada para el proceso MongoDB
  • Cantidad de espacio libre y utilizado en la partición del disco utilizada para el proceso MongoDB
  • Medidas para el host, como el uso de la CPU o el número de operaciones de E/S

Para utilizar este recurso, la cuenta de servicio o la clave API solicitante debe tener la función de solo lectura del proyecto.

Parámetros de ruta

  • ID de grupo string Requerido

    Cadena 24hexadecimal única que identifica su proyecto. Utilice el punto de conexión /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 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".

    El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

  • processId string Requerido

    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 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})$.

Parámetros de consulta

  • envolvente booleano

    Indicador que indica si la aplicación encapsula 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 solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como encapsulado. La aplicación añade el parámetro de estado al cuerpo de la respuesta.

    El valor predeterminado es false.

  • bonita booleano

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

    El valor predeterminado es false.

    Impresión bonita
  • m array[string]

    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 parámetro m para cada valor. Especifique las mediciones que se aplican al host especificado. MongoDB Cloud devuelve un error si especificó alguna medición no válida.

    Al menos 1 pero no más de 10 elementos. Los valores son ASSERT_MSG, ASSERT_REGULAR, ASSERT_USER, ASSERT_WARNING, BACKGROUND_FLUSH_AVG, CACHE_BYTES_READ_INTO, CACHE_BYTES_WRITTEN_FROM, CACHE_DIRTY_BYTES, CACHE_USED_BYTES, CACHE_FILL_RATIO, DIRTY_FILL_RATIO, COMPUTED_MEMORY, CONNECTIONS, CURSORS_TOTAL_OPEN, CURSORS_TOTAL_TIMED_OUT, DB_DATA_SIZE_TOTAL, DB_STORAGE_TOTAL, DOCUMENT_METRICS_DELETED, DOCUMENT_METRICS_INSERTED, DOCUMENT_METRICS_RETURNED, DOCUMENT_METRICS_UPDATED, EXTRA_INFO_PAGE_FAULTS, FTS_DISK_UTILIZATION, FTS_MEMORY_MAPPED, FTS_MEMORY_RESIDENT, FTS_MEMORY_VIRTUAL, FTS_PROCESS_CPU_KERNEL, FTS_PROCESS_CPU_USER, FTS_PROCESS_NORMALIZED_CPU_KERNEL, FTS_PROCESS_NORMALIZED_CPU_USER, GLOBAL_ACCESSES_NOT_IN_MEMORY, GLOBAL_LOCK_CURRENT_QUEUE_READERS, GLOBAL_LOCK_CURRENT_QUEUE_TOTAL, GLOBAL_LOCK_CURRENT_QUEUE_WRITERS, GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN, INDEX_COUNTERS_BTREE_ACCESSES, INDEX_COUNTERS_BTREE_HITS, INDEX_COUNTERS_BTREE_MISS_RATIO, INDEX_COUNTERS_BTREE_MISSES, JOURNALING_COMMITS_IN_WRITE_LOCK, JOURNALING_MB, JOURNALING_WRITE_DATA_FILES_MB, MAX_PROCESS_CPU_CHILDREN_KERNEL, MAX_PROCESS_CPU_CHILDREN_USER, MAX_PROCESS_CPU_KERNEL, MAX_PROCESS_CPU_USER, MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL, MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER, MAX_PROCESS_NORMALIZED_CPU_KERNEL, MAX_PROCESS_NORMALIZED_CPU_USER, MAX_SWAP_USAGE_FREE, MAX_SWAP_USAGE_USED, MAX_SYSTEM_CPU_GUEST, MAX_SYSTEM_CPU_IOWAIT, MAX_SYSTEM_CPU_IRQ, MAX_SYSTEM_CPU_KERNEL, MAX_SYSTEM_CPU_SOFTIRQ, MAX_SYSTEM_CPU_STEAL, MAX_SYSTEM_CPU_USER, MAX_SYSTEM_MEMORY_AVAILABLE, MAX_SYSTEM_MEMORY_FREE, MAX_SYSTEM_MEMORY_USED, MAX_SYSTEM_NETWORK_IN, MAX_SYSTEM_NETWORK_OUT, MAX_SYSTEM_NORMALIZED_CPU_GUEST, MAX_SYSTEM_NORMALIZED_CPU_IOWAIT, MAX_SYSTEM_NORMALIZED_CPU_IRQ, MAX_SYSTEM_NORMALIZED_CPU_KERNEL, MAX_SYSTEM_NORMALIZED_CPU_NICE, MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ, MAX_SYSTEM_NORMALIZED_CPU_STEAL, MAX_SYSTEM_NORMALIZED_CPU_USER, MEMORY_MAPPED, MEMORY_RESIDENT, MEMORY_VIRTUAL, NETWORK_BYTES_IN, NETWORK_BYTES_OUT, NETWORK_NUM_REQUESTS, OP_EXECUTION_TIME_COMMANDS, OP_EXECUTION_TIME_READS, OP_EXECUTION_TIME_WRITES, OPCOUNTER_CMD, OPCOUNTER_DELETE, OPCOUNTER_TTL_DELETED, OPCOUNTER_GETMORE, OPCOUNTER_INSERT, OPCOUNTER_QUERY, OPCOUNTER_REPL_CMD, OPCOUNTER_REPL_DELETE, OPCOUNTER_REPL_INSERT, OPCOUNTER_REPL_UPDATE, OPCOUNTER_UPDATE, OPERATIONS_SCAN_AND_ORDER, OPERATIONS_QUERIES_KILLED, OPLOG_MASTER_LAG_TIME_DIFF, OPLOG_MASTER_TIME, OPLOG_RATE_GB_PER_HOUR, OPLOG_SLAVE_LAG_MASTER_TIME, OPLOG_REPLICATION_LAG, PROCESS_CPU_CHILDREN_KERNEL, PROCESS_CPU_CHILDREN_USER, PROCESS_CPU_KERNEL, PROCESS_CPU_USER, PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL, PROCESS_NORMALIZED_CPU_CHILDREN_USER, PROCESS_NORMALIZED_CPU_KERNEL, PROCESS_NORMALIZED_CPU_USER, QUERY_EXECUTOR_SCANNED, QUERY_EXECUTOR_SCANNED_OBJECTS, QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED, QUERY_TARGETING_SCANNED_PER_RETURNED, RESTARTS_IN_LAST_HOUR, SWAP_USAGE_FREE, SWAP_USAGE_USED, SYSTEM_CPU_GUEST, SYSTEM_CPU_IOWAIT, SYSTEM_CPU_IRQ, SYSTEM_CPU_KERNEL, SYSTEM_CPU_NICE, SYSTEM_CPU_SOFTIRQ, SYSTEM_CPU_STEAL, SYSTEM_CPU_USER, SYSTEM_MEMORY_AVAILABLE, SYSTEM_MEMORY_FREE, SYSTEM_MEMORY_USED, SYSTEM_NETWORK_IN, SYSTEM_NETWORK_OUT, SYSTEM_NORMALIZED_CPU_GUEST, SYSTEM_NORMALIZED_CPU_IOWAIT, SYSTEM_NORMALIZED_CPU_IRQ, SYSTEM_NORMALIZED_CPU_KERNEL, SYSTEM_NORMALIZED_CPU_NICE, SYSTEM_NORMALIZED_CPU_SOFTIRQ, SYSTEM_NORMALIZED_CPU_STEAL, SYSTEM_NORMALIZED_CPU_USER, TICKETS_AVAILABLE_READS, TICKETS_AVAILABLE_WRITE, OPERATION_THROTTLING_REJECTED_OPERATIONS o QUERY_SPILL_TO_DISK_DURING_SORT.

  • período string

    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.

  • granularidad string Requerido

    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.

  • Inicio cadena(fecha-hora)

    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.

  • end cadena(fecha-hora)

    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.

Respuestas

  • 200 application/vnd.atlas.2023-01-01+json

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • nombreDeBaseDeDatos string

      Etiqueta legible por humanos que identifica la base de datos a la que sirve el proceso MongoDB especificado.

    • end cadena(fecha-hora)

      Fecha y hora que especifica cuándo detener la recuperación de mediciones. Si se establece el fin, debe establecerse el inicio. No se puede establecer este parámetro y el período en la misma solicitud. Este parámetro expresa su valor en el 8601 formato de marca de tiempo ISO en UTC.

    • granularidad string

      Duración que especifica el intervalo entre los puntos de datos de medición. El parámetro expresa su valor en 8601 formato de marca de tiempo ISO en UTC. Si se configura este parámetro, se debe especificar el período o el inicio y el fin.

      Los valores son PT1M, PT5M, PT1H o P1D.

    • ID de grupo string

      Cadena única de dígitos hexadecimales 24que identifica el proyecto. El proyecto contiene los procesos MongoDB que desea devolver. El proceso MongoDB puede ser mongod o mongos.

      El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

    • ID de host string

      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 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})$.

    • mediciones matriz[objeto]

      Lista que contiene mediciones y sus puntos de datos.

      Ocultar atributos de medición Mostrar atributos de mediciones Objeto
      • puntos de datos matriz[objeto]

        Lista que contiene el valor y los metadatos proporcionados para un punto de datos generado en un momento determinado. Si no existe ningún punto de datos para un momento determinado, el parámetro value devuelve null.

        Valor y metadatos proporcionados para un punto de datos generado en un momento específico. Si no existen puntos de datos para un momento específico en el tiempo, el parámetro value devuelve null.

        Ocultar atributos de dataPoints Mostrar atributos de dataPoints Objeto
        • fecha y hora cadena(fecha-hora)

          Fecha y hora en que se produjo este punto de datos. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

        • valor Número

          Valor que comprende este punto de datos.

      • Nombre string

        Etiqueta legible por humanos de la medición que cubre este punto de datos.

      • unidades string

        Elemento utilizado para cuantificar la medición. El recurso devuelve unidades de rendimiento, almacenamiento y tiempo.

        Los valores son BYTES, BYTES_PER_SECOND, GIGABYTES, GIGABYTES_PER_HOUR, MEGABYTES_PER_SECOND, MICROSECONDS, MILLISECONDS, PERCENT, SCALAR o SCALAR_PER_SECOND.

    • nombreDePartición string

      Etiqueta legible por humanos del disco o partición al que se aplican las mediciones.

    • processId string

      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 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})$.

    • Inicio cadena(fecha-hora)

      Fecha y hora que especifica cuándo se empezarán a recuperar las mediciones. Si se establece el inicio, debe establecerse el fin. No se puede establecer este parámetro y el período en la misma solicitud. Este parámetro expresa su valor en el 8601 formato de marca de tiempo ISO en UTC.

  • 401 aplicación/json

    No autorizado.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 403 aplicación/json

    Forbidden.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 404 aplicación/json

    No se encontró.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 500 aplicación/json

    Error Interno del Servidor.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

OBTENER /api/atlas/v2/grupos/{ID_grupo}/procesos/{ID_proceso}/mediciones
atlas api monitoringAndLogs getProcessMeasurements --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20241113001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.GetGroupProcessMeasurementsApiParams{}
	sdkResp, httpResp, err := client.MonitoringandLogsApi.
		GetGroupProcessMeasurementsWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2024-11-13+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2024-11-13+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true"
Ejemplos de respuestas (200)
{
  "databaseName": "string",
  "end": "2026-05-04T09:42:00Z",
  "granularity": "PT1M",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "hostId": "mongodb.example.com:27017",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "measurements": [
    {
      "dataPoints": [
        {
          "timestamp": "2026-05-04T09:42:00Z",
          "value": 42.0
        }
      ],
      "name": "string",
      "units": "BYTES"
    }
  ],
  "partitionName": "string",
  "processId": "mongodb.example.com:27017",
  "start": "2026-05-04T09:42:00Z"
}
Ejemplos de respuestas (401)
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
Ejemplos de respuestas (403)
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
Ejemplos de respuestas (404)
{
  "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"
}
Ejemplos de respuestas (500)
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}