/ /

/ /

Comience a monitorear un host

Cloud Manager dejará de ofrecer compatibilidad con automatización, copias de seguridad y monitorización para MongoDB 3.6 y 4.0 a partir del 30de agosto de 2024. Por favor, Actualice su implementación de MongoDB o migre a Atlas.

Nota

Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} Es el mismo que el ID de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. Esta página utiliza el término "grupo" para las descripciones. El punto final se mantiene como se indica en el documento.

Comienza a supervisar un nuevo proceso de MongoDB. El sistema de supervisión inicia la supervisión del proceso de MongoDB en el nombre de host y el puerto que especifiques. Cloud Manager solo conoce la información que proporcionas. El documento de respuesta incluye valores en blanco hasta que Cloud Manager completa el descubrimiento de la configuración de los procesos de MongoDB.

URL base: https://cloud.mongodb.com/api/public/v1.0

Resource

POST /groups/{PROJECT-ID}/hosts

Parámetros de la ruta de solicitud

Parameter	Tipo	Necesidad	Descripción
PROJECT-ID	string	Requerido	Identificador único del proyecto propietario de este proceso MongoDB.

Parámetros de consulta de solicitud

Los siguientes parámetros de consulta son opcionales:

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonita

booleano

Opcional

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

false

envolvente

booleano

Opcional

Bandera que indica si se debe o no envolver la respuesta en un sobre.

Algunos Los clientes de laAPI no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta.

Para los puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre	Descripción
`status`	Código de respuestaHTTP
`content`	Cuerpo de respuesta esperado

false

Parámetros del cuerpo de la solicitud

Nombre	Tipo	Necesidad	Descripción
alertsEnabled	booleano	Opcional	Establezca en `true` si se deben habilitar alertas para este proceso de MongoDB.
nombreDeMecanismoDeAutorización	string	Opcional	Especifique el mecanismo de autenticación que se debe utilizar para conectarse a este proceso de MongoDB. Los valores posibles son: `MONGODB_CR` (Esto cubre SCRAM-SHA-1, SCRAM-SHA-256 y MONGODB-CR). `GSSAPI` `PLAIN` `MONGODB_X509` `NONE`
Nombre del host	string	Requerido	Establezca el nombre de host principal que Cloud Manager debe usar para conectarse a esta instancia de MongoDB.
registros habilitados	booleano	Opcional	Establezca en `true` si Cloud Manager debe recopilar registros para este proceso de MongoDB.
contraseña	string	Opcional	Contraseña asociada a `username` para conectarse a este proceso de MongoDB. Establezca este parámetro si `"authMechanismName" : "MONGODB_CR"` Cloud Manager no incluye este parámetro en ninguna respuesta de Host \|\|.
Puerto	Número	Requerido	Puerto en el que escucha el proceso MongoDB.
perfilador habilitado	booleano	Opcional	Bandera que indica si Cloud Manager recopila información de perfil de este proceso MongoDB.
SSL habilitado	booleano	Condicional	Bandera que indica si TLS debe habilitarse para este proceso MongoDB. Establezca en `true` si `"authMechanismName" : "MONGODB_X509"`.
Nombre de usuario	string	Condicional	Se necesita un nombre de usuario para conectarse a este proceso MongoDB. Requerido si `"authMechanismName" : "MONGODB_CR"`

Respuesta

Nombre	Tipo	Descripción
aliases	matriz de cadenas	Matriz de combinaciones alternativas de nombres de host y puertos que Cloud Manager detectó para el proceso MongoDB. Estas combinaciones pueden incluir nombres de host, FQDN,direccionesIPv4 y direcciones IPv.6
alertsEnabled	booleano	`true` si este proceso MongoDB tiene alertas habilitadas.
nombreDeMecanismoDeAutorización	string	Mecanismo de autenticación utilizado para conectarse a este proceso de MongoDB. Muestra solo uno de los siguientes valores: `MONGODB_CR` (Esto cubre SCRAM-SHA-1, SCRAM-SHA-256 y MONGODB-CR). `GSSAPI` `PLAIN` `MONGODB_X509` `NONE`
clusterId	string	Identificador único del clúster al que pertenece el proceso MongoDB.
creado	fecha	Fecha en que Cloud Manager creó o descubrió por primera vez este proceso MongoDB.
ID de grupo	string	Identificador único del grupo propietario de este host.
tiene advertencias de inicio	booleano	`true` Si este proceso MongoDB tuvo advertencias de inicio.
ocultos	booleano	`true` Si el host se muestra en la interfaz de usuario de Cloud Manager,`true` los hosts configurados como se omiten en las respuestas de la API.
ocultoSecundario	booleano	`true` si este host es un secundario oculto.
host habilitado	booleano	`true` si el proceso MongoDB está actualmente habilitado.
Nombre del host	string	Nombre de host principal que Cloud Manager puede determinar mejor. Puede ser un nombre de host, un FQDN, una dirección IPv4 o una6 dirección IPv.
ID.	string	Unique identifier.
dirección IP	string	Dirección IPv4 o IPv6 asociada con el `hostname` de este proceso de MongoDB. Se pueden mostrar direcciones IPv4 o IPv accesibles adicionales en la6 `aliases` matriz.
registro en diario habilitado	booleano	`true` si el registro en diario está habilitado para este proceso MongoDB.
últimosBytes de Tamaño de Datos	Número	Tamaño`lastDataSizeBytes` sin comprimir de las bases de datos del host en el disco en bytes excluyendo los índices. no incluye los datos de la base de datos local.
lastIndexSizeBytes	Número	Tamaño sin comprimir de los índices de la base de datos del host en disco, en bytes. Este número no incluye el tamaño del índice de la base de datos local.
último ping	fecha	Marca de tiempo en formato ISO 8601 de fecha y hora en UTC cuando se recibió el último ping para este proceso MongoDB.
último reinicio	fecha	Marca de tiempo en formato ISO 8601 de fecha y hora UTC del último reinicio de este proceso. Si el proceso MongoDB nunca se ha reiniciado,`lastRestart` se omite el campo.
enlaces	arreglo	Matriz que incluye uno o más enlaces a subrecursos o recursos relacionados. Las relaciones entre las URL se explican en la Especificación de Enlaces Web. Como mínimo, una `links` matriz contiene un enlace `self` llamado.
registros habilitados	booleano	`true` si Cloud Manager está recopilando registros para este proceso MongoDB.
límiteU bajo	booleano	`true` si el host de este proceso de MongoDB tiene una configuración baja de `ulimit`.
Puerto	Número	Puerto en el que escucha el proceso MongoDB.
perfilador habilitado	booleano	`true` si Cloud Manager recopila información de perfil de este proceso MongoDB.
nombreConjuntoRéplica	string	Nombre del set de réplicas al que pertenece este proceso. Solo está presente si este proceso forma parte de un set de réplicas.
replicaStateName	string	Estado actual de este proceso de MongoDB dentro de un conjunto de réplicas. Solo está presente si este proceso forma parte de un conjunto de réplicas. Consulte los estados miembros del conjunto de réplicas para ver los posibles valores.
nombrefragmento	string	Nombre de la partición a la que pertenece este proceso. Solo se aplica si el proceso forma parte de un clúster fragmentado.
segundos de retraso secundarios	Número	Número de segundos que los datos de este miembro del conjunto de réplicas siguen al principal. Si este valor se establece `0` en, el miembro no se configura como miembro retrasado. Para obtener más información sobre los retrasos secundarios, consulte Miembros del conjunto de réplicas retrasados.
SSL habilitado	booleano	`true` si TLS/SSL está habilitado para este proceso MongoDB.
Información del sistema	Objeto	Objeto que contiene información de RAM y CPU para el servidor de este proceso MongoDB según lo informado por el sistema operativo o el contenedor.
systemInfo.memSizeMB	Número	Cantidad de RAM en megabytes.
systemInfo.numCores	Número	Número de núcleos de CPU.
tipoNombre	string	Tipo para este proceso de MongoDB. Los valores posibles son: `STANDALONE` `REPLICA_PRIMARY` `REPLICA_SECONDARY` `REPLICA_ARBITER` `RECOVERING` `SHARD_MONGOS` `SHARD_CONFIG` `SHARD_STANDALONE` `SHARD_PRIMARY` `SHARD_SECONDARY` `NO_DATA` El tipo para nuevos hosts añadidos a Cloud Manager será `NO_DATA` hasta que supervisión reciba su primer ping.
tiempo de actividad en mseg	Número	Número de milisegundos desde el último reinicio de este proceso.
Versión	string	Versión de MongoDB que se ejecuta para este proceso.

Ejemplo de solicitud

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request POST "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts?pretty=true" \
     --data '
       {
         "hostname": "server1.example.com",
         "port": 27017
       }'

Ejemplo de respuesta

Encabezado de respuesta

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 201 Created
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Cuerpo de respuesta

1 {
2   "alertsEnabled" : true,
3   "authMechanismName" : "NONE",
4   "created" : "2014-04-22T19:56:50Z",
5   "groupId" : "{PROJECT-ID}",
6   "hasStartupWarnings" : false,
7   "hidden" : false,
8   "hostEnabled" : true,
9   "hostname" : "server1.example.com",
10   "id" : "{HOST-ID}",
11   "journalingEnabled" : false,
12   "links" : [  ],
13   "logsEnabled" : false,
14   "lowUlimit" : false,
15   "port" : 27017,
16   "profilerEnabled" : false,
17   "sslEnabled" : false
18   "systemInfo" : {
19     "memSizeMB" : 65536,
20     "numCores" : 16
21   },
22 }

Volver

Obtener por nombre de host y puerto

Update

1	{
2	"alertsEnabled" : true,
3	"authMechanismName" : "NONE",
4	"created" : "2014-04-22T19:56:50Z",
5	"groupId" : "{PROJECT-ID}",
6	"hasStartupWarnings" : false,
7	"hidden" : false,
8	"hostEnabled" : true,
9	"hostname" : "server1.example.com",
10	"id" : "{HOST-ID}",
11	"journalingEnabled" : false,
12	"links" : [ ],
13	"logsEnabled" : false,
14	"lowUlimit" : false,
15	"port" : 27017,
16	"profilerEnabled" : false,
17	"sslEnabled" : false
18	"systemInfo" : {
19	"memSizeMB" : 65536,
20	"numCores" : 16
21	},
22	}