/ /

Implementaciones

host

Docs Home

Gestión

Gerente de Operaciones

Obtener todos los hosts en un proyecto

Nota

Grupos y proyectos son términos sinónimos. Su {PROJECT-ID} es el mismo que su ID del grupo. Para los grupos existentes, el ID del grupo se mantiene igual. Esta página utiliza el término más familiar grupo cuando se refiere a descripciones. El endpoint permanece tal como se indica en el documento.

Obtén todos los hosts de MongoDB en un proyecto. Utiliza el parámetro de **query** clusterId para obtener únicamente los hosts que pertenezcan al clúster especificado. La respuesta ordena los hosts alfabéticamente por NOMBRE DE HOST:PUERTO.

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

GET /groups/{PROJECT-ID}/hosts

Parámetros de ruta de solicitud

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

Parámetros de Solicitud Query

Nombre	Tipo	Necesidad	Descripción	predeterminado
Num. de pág.	Número	Opcional	Entero basado en uno que devuelve una subsección de resultados.	`1`
elementosPorPágina	Número	Opcional	Número de elementos a devolver por página, hasta un máximo de 500.	`100`
bonito	booleano	Opcional	Indicador que indica si el cuerpo de la respuesta debe estar en un prettyprint formato.	`false`
envelope	booleano	Opcional	Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos clientes de 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. Para los endpoints que devuelven una lista de resultados, el objeto `content` es un sobre. Ops Manager agrega el campo `status` al cuerpo de la respuesta.	`false`

Parameter	Tipo	Necesidad	Descripción
clusterId	string	Requerido	Identificador único del clúster al que pertenece este proceso de MongoDB.

Parámetros del cuerpo de la solicitud

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Respuesta

Documento de respuesta

El documento JSON de respuesta incluye una matriz de objetos result, una matriz de objetos link y un recuento del número total de objetos result recuperados.

Nombre	Tipo	Descripción
`results`	arreglo	El arreglo incluye un objeto para cada elemento detallado en la sección del `results` documento incrustado.
`links`	arreglo	El arreglo incluye uno o más enlaces a subrecursos y/o recursos relacionados. Las relaciones entre URLse explican en la Especificación de enlace web.
`totalCount`	Número	Recuento entero del número total de elementos en el conjunto de resultados. Puede ser superior al número de objetos en el arreglo results si el conjunto de resultados completo está paginado.

`results` embeddedDocument

Cada resultado es un host.

Nombre	Tipo	Descripción
aliases	Arreglo de cadenas	Conjunto de combinaciones alternativas de nombre de host y puerto que Ops Manager detectó para el proceso de MongoDB. Estas combinaciones pueden incluir nombres de host, nombres de dominio completos (FQDN), direccionesIPv4 y direcciones IPv6.
alertsEnabled	booleano	`true` si este proceso de MongoDB tiene alertas habilitadas.
authMechanismName	string	Mecanismo de autenticación utilizado para conectar a este proceso de MongoDB. Esto muestra sólo 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 la que el Ops Manager creó o descubrió por primera vez este proceso de MongoDB.
ID del grupo	string	Identificador único del grupo responsable de este host.
tieneAdvertenciasDeInicio	booleano	`true` si este proceso de MongoDB tuvo advertencias al inicio.
ocultos	booleano	`true` si el host se muestra en la Interfaz de Usuario de Ops Manager. Los hosts configurados en `true` se omiten de las respuestas de 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	El administrador de operaciones puede determinar mejor el nombre de host principal. Este puede ser un nombre de host, un FQDN, una dirección IPv4 o una dirección IPv6.
ID	string	Unique identifier.
Dirección IP	string	Dirección IPv4 o IPv6 asociada con el `hostname` de este proceso de MongoDB. Es posible que se muestren direcciones IPv4 o IPv6 adicionales accesibles en el array `aliases`.
registradores activados	booleano	`true` si registrar en la bitácora está habilitado para este proceso de 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 de fecha y hora ISO 8601 en UTC cuando se recibió el último ping para este proceso de MongoDB.
lastRestart	fecha	Marca de tiempo en formato ISO 8601 (fecha y hora UTC) que indica la última vez que se reinició este proceso. Si el proceso de MongoDB nunca se ha reiniciado, se omite el campo `lastRestart`.
enlaces	arreglo	Matriz que incluye uno o más enlaces a subrecursos y/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.
logsEnabled	booleano	`true` si Ops Manager está recopilando registros para este proceso de 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 de 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 set de réplicas retrasan respecto al primario. Si este valor está configurado en `0`, el nodo no está configurado como miembro atrasado. Para obtener más detalles sobre retrasos secundarios, consulta Miembros retrasados del set de réplicas
sslEnabled	booleano	`true` si TLS 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.

Nota

Algunos hosts no devuelven clusterId. Esto ocurre cuando un proceso mongos dirige operaciones de datos a particiones que no almacenan datos. Ops Manager no asigna un clusterId a algunos nodos que no contienen datos.

Solicitud de ejemplo

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --include \
 --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/hosts?pretty=true"

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 200 OK
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   "totalCount" : 2,
3   "results" : [
4     {
5       "alertsEnabled" : true,
6       "aliases": [ "{HOSTNAME}:26000", "{IP-ADDRESS}:26000" ],
7       "authMechanismName" : "SCRAM-SHA-1",
8       "clusterId" : "{CLUSTER-ID}",
9       "created" : "2024-04-22T19:56:50Z",
10       "groupId" : "{PROJECT-ID}",
11       "hasStartupWarnings" : false,
12       "hidden" : false,
13       "hostEnabled" : true,
14       "hostname" : "{HOSTNAME}",
15       "id" : "{HOST-ID}",
16       "ipAddress": "127.0.0.1",
17       "journalingEnabled" : false,
18       "lastDataSizeBytes" : 633208918,
19       "lastIndexSizeBytes" : 101420524,
20       "lastPing" : "2024-08-18T11:23:41Z",
21       "links" : [  ],
22       "logsEnabled" : false,
23       "lowUlimit" : false,
24       "muninEnabled" : false,
25       "port" : 26000,
26       "profilerEnabled" : false,
27       "replicaSetName": "rs1",
28       "replicaStateName" : "PRIMARY",
29       "sslEnabled" : true,
30       "systemInfo" : {
31         "memSizeMB" : 65536,
32         "numCores" : 16
33       },
34       "typeName": "REPLICA_PRIMARY",
35       "uptimeMsec": 1827300394,
36       "username" : "mongo",
37       "version" : "4.4.0"
38     },
39     {
40 
41     }
42   ]
43 }

Nota

Aunque Ops Manager devuelve muninEnabled en la respuesta, Munin no es compatible a partir de Ops 4 4Manager..

Volver

host

Obtener por ID

1	{
2	"totalCount" : 2,
3	"results" : [
4	{
5	"alertsEnabled" : true,
6	"aliases": [ "{HOSTNAME}:26000", "{IP-ADDRESS}:26000" ],
7	"authMechanismName" : "SCRAM-SHA-1",
8	"clusterId" : "{CLUSTER-ID}",
9	"created" : "2024-04-22T19:56:50Z",
10	"groupId" : "{PROJECT-ID}",
11	"hasStartupWarnings" : false,
12	"hidden" : false,
13	"hostEnabled" : true,
14	"hostname" : "{HOSTNAME}",
15	"id" : "{HOST-ID}",
16	"ipAddress": "127.0.0.1",
17	"journalingEnabled" : false,
18	"lastDataSizeBytes" : 633208918,
19	"lastIndexSizeBytes" : 101420524,
20	"lastPing" : "2024-08-18T11:23:41Z",
21	"links" : [ ],
22	"logsEnabled" : false,
23	"lowUlimit" : false,
24	"muninEnabled" : false,
25	"port" : 26000,
26	"profilerEnabled" : false,
27	"replicaSetName": "rs1",
28	"replicaStateName" : "PRIMARY",
29	"sslEnabled" : true,
30	"systemInfo" : {
31	"memSizeMB" : 65536,
32	"numCores" : 16
33	},
34	"typeName": "REPLICA_PRIMARY",
35	"uptimeMsec": 1827300394,
36	"username" : "mongo",
37	"version" : "4.4.0"
38	},
39	{
40
41	}
42	]
43	}

Obtener todos los hosts en un proyecto

Resource

Parámetros de ruta de solicitud

Parámetros de Solicitud Query

Parámetros del cuerpo de la solicitud

Respuesta

Documento de respuesta

results embeddedDocument

Solicitud de ejemplo

Respuesta de ejemplo

Encabezado de respuesta

Respuesta del cuerpo

`results` embeddedDocument