/ /

Gerente de Operaciones

Obtener un host por nombre de host y puerto

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 grupo/proyecto permanece igual. Esta página utiliza el término más familiar «grupo» al referirse a las descripciones. El punto final se mantiene como se indica en el documento.

Obtenga un proceso de MongoDB por su nombre de host y puerto. Puede especificar el nombre de host principal o un alias.

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

Resource

GET /groups/{PROJECT-ID}/hosts/byName/{HOSTNAME}:{PORT}

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.
Nombre del host	string	Requerido	Nombre de host principal que Ops Manager debe usar para conectarse a esta instancia de MongoDB. Este nombre de host puede ser un nombre de host, un FQDN, una dirección IPv4 o una dirección IPv6.
Puerto	string	Requerido	Puerto en el que escucha el 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 clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, ajusta envelope=true en la query.

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

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

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" \
 --include \
 --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/hosts/byName/server1.example.com:27017?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   "alertsEnabled" : true,
3   "aliases": [ "server1.example.com:27017", "10.1.0.10:27017" ],
4   "authMechanismName" : "SCRAM-SHA-1",
5   "clusterId" : "{CLUSTER-ID}",
6   "created" : "2024-04-22T19:56:50Z",
7   "groupId" : "{PROJECT-ID}",
8   "hasStartupWarnings" : false,
9   "hidden" : false,
10   "hostEnabled" : true,
11   "hostname" : "server1.example.com",
12   "id" : "{HOST-ID}",
13   "ipAddress": "10.1.0.10",
14   "journalingEnabled" : false,
15   "lastDataSizeBytes" : 633208918,
16   "lastIndexSizeBytes" : 101420524,
17   "lastPing" : "2024-08-18T11:23:41Z",
18   "links" : [  ],
19   "logsEnabled" : false,
20   "lowUlimit" : false,
21   "muninEnabled" : false,
22   "port" : 27017,
23   "profilerEnabled" : false,
24   "replicaSetName": "rs1",
25   "replicaStateName" : "PRIMARY",
26   "sslEnabled" : true,
27   "systemInfo" : {
28     "memSizeMB" : 65536,
29     "numCores" : 16
30   },
31   "typeName": "REPLICA_PRIMARY",
32   "uptimeMsec": 1827300394,
33   "username" : "mongodb",
34   "version" : "4.4.0"
35 }

Nota

Aunque Ops Manager devuelve muninEnabled en la respuesta, Munin no se admite a partir de Ops Manager 4.4.

Volver

Obtener por ID

Comenzar la supervisión

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