/ /

Gerente de Operaciones

Comience a monitorear un host

Nota

Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} es el mismo que tu id. de proyecto. Para los grupos existentes, su ID de grupo/ID del grupo seguirá siendo el mismo. Esta página utiliza el término más familiar grupo al referirse a descripciones. El endpoint se mantiene tal como se indica en el documento.

Comience a monitorear un nuevo proceso de MongoDB. La supervisión comienza a supervisar el proceso de MongoDB en el nombre de host y puerto que especificas. Ops Manager solo conoce la información que usted proporciona. El documento de respuestas incluye valores vacíos hasta que Ops Manager complete el descubrimiento de la configuración de los procesos de MongoDB.

URL base: https://{OPSMANAGER-HOST}:{PORT}/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 Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonito

booleano

Opcional

Indicador que señala si el cuerpo de la respuesta debe estar en un pretty-print formato.

false

envelope

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 endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre	Descripción
`status`	Código de respuesta HTTP
`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 las alertas deben estar habilitadas para este proceso de MongoDB.
authMechanismName	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	Establece el nombre de host primario que Ops Manager debe usar para conectarse a esta instancia de MongoDB.
registros habilitados	booleano	Opcional	Configure en `true` si Ops 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. Configura este parámetro si `"authMechanismName" : "MONGODB_CR"` Ops Manager no incluye este parámetro en ninguna Host \|\| respuesta.
Puerto	Número	Requerido	Puerto en el que escucha el proceso de MongoDB.
profilerEnabled	booleano	Opcional	Bandera que indica si Ops Manager recopila información de perfil de este proceso de MongoDB.
SSL habilitado	booleano	Condicional	Bandera que indica si TLS debe habilitarse para este proceso MongoDB. Configure en `true` si `"authMechanismName" : "MONGODB_X509"`.
Nombre de usuario	string	Condicional	Se necesita un nombre de usuario para conectarse a este proceso MongoDB. Obligatorio si `"authMechanismName" : "MONGODB_CR"`

Respuesta

Nombre	Tipo	Descripción
aliases	Arreglo de cadenas	Arreglo de combinaciones alternativas de nombres de host y puertos que Ops Manager descubrió para el proceso de MongoDB. Estas combinaciones pueden incluir nombres de host, FQDNs, Direcciones IPv4 e IPv6.
alertsEnabled	booleano	`true` si este proceso de MongoDB tiene alertas habilitadas.
authMechanismName	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 de MongoDB.
creado	fecha	Fecha en que Ops Manager creó o descubrió por primera vez este proceso MongoDB.
ID del grupo	string	Identificador único del grupo responsable de este host.
tieneAdvertenciasDeInicio	booleano	`true` Si este proceso MongoDB tuvo advertencias de inicio.
ocultos	booleano	`true` Si el host se muestra en la interfaz de usuario de Ops Manager,`true` los hosts configurados como se omiten en las respuestas de la API.
hiddenSecondary	booleano	`true` si este host es un secundario oculto.
hostEnabled	booleano	`true` si el proceso de MongoDB está actualmente habilitado.
Nombre del host	string	Nombre de host primario conforme Ops Manager lo pueda determinar. Esto puede ser un nombre de host, un FQDN, una dirección de IPv4 o una dirección de IPv6.
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 IPv6 accesibles adicionales en la `aliases` matriz.
registradores activados	booleano	`true` si el registro en diario está habilitado para este proceso MongoDB.
lastDataSizeBytes	Número	Tamaño no comprimido de las bases de datos del host en disco en bytes, excluyendo los índices. `lastDataSizeBytes` no incluye los datos en 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 para la base de datos local.
lastPing	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 Ops Manager está recopilando registros para este proceso MongoDB.
lowUlimit	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.
profilerEnabled	booleano	`true` si Ops Manager recopila información de perfil de este proceso de MongoDB.
replicaSetName	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 set de réplicas. Solo está presente si este proceso forma parte de un set de réplicas. Consulte Estados del set de réplicas para posibles valores.
shardName	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.
secondaryDelaySecs	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 de MongoDB.
systemInfo	Objeto	Objeto que contiene información de RAM y CPU para el servidor de este proceso de 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.
typeName	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 los nuevos hosts añadidos a Ops Manager será `NO_DATA` hasta que la supervisión reciba su primer ping.
uptimeMsec	Número	Número de milisegundos desde la última vez que este proceso se reinició.
Versión	string	Versión de MongoDB ejecutada para este proceso.

Solicitud de ejemplo

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

Respuesta de ejemplo

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}

Respuesta del cuerpo

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

Actualizar configuración

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	}