/ /

/ /

Obtener todos los hosts en un proyecto

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.

Obtenga todos los hosts de MongoDB en un proyecto. Use el parámetro de consulta CLUSTER-ID para obtener únicamente los hosts que pertenecen al clúster especificado. La respuesta ordena los hosts alfabéticamente por HOSTNAME:PORT.

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

Resource

GET /groups/{PROJECT-ID}/hosts

GET /groups/{PROJECT-ID}/hosts?clusterId={CLUSTER-ID}

Parámetros de la ruta de solicitud

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

Parámetros de consulta de solicitud

Nombre	Tipo	Necesidad	Descripción	predeterminado
número de página	Número	Opcional	Entero basado en uno que devuelve una subsección de resultados.	`1`
artículos por página	Número	Opcional	Número de artículos a devolver por página, hasta un máximo de 500.	`100`
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 endpoints que devuelven una lista de resultados, el objeto `content` es un sobre. Cloud Manager añade el campo `status` al cuerpo de la respuesta.	`false`
trabajos de respaldo habilitados solamente	booleano	Opcional	Indicador que indica si se deben excluir de la respuesta los daemons no habilitados para realizar copias de seguridad de bases de datos. Establezca este valor en `false` para incluir las configuraciones de daemon con el indicador `backupJobsEnabled` establecido en `false`.	`true`

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

Parámetros del cuerpo de la solicitud

Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.

Respuesta

Documento de respuesta

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

Nombre	Tipo	Descripción
`results`	arreglo	La matriz incluye un objeto para cada elemento detallado en el Sección`results` de documento incrustado.
`links`	arreglo	La matriz incluye uno o más enlaces a subrecursos o recursos relacionados. Las relaciones entre las URLse explican en la Especificación de Enlaces Web.
`totalCount`	Número	Número entero del número total de elementos en el conjunto de resultados. Puede ser mayor que el número de objetos en la matriz results si todo el conjunto de resultados está paginado.

`results` Documento incrustado

Cada resultado es un host.

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.

Nota

Algunos hosts no devuelven el clusterId. Esto ocurre cuando un mongos proceso enruta operaciones de datos a fragmentos que no almacenan datos. Cloud Manager no asigna un clusterId a algunos nodos que no almacenan datos.

Ejemplo de solicitud

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

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

Cuerpo de respuesta

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" : "2014-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" : "2016-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.0.0"
38     },
39     {
40 
41     }
42   ]
43 }

Nota

Aunque Cloud Manager devuelve muninEnabled en la respuesta, Munin no es compatible.

Volver

Hosts

Obtener por identificación

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" : "2014-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" : "2016-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.0.0"
38	},
39	{
40
41	}
42	]
43	}

Nota

Resource

Parámetros de la ruta de solicitud

Parámetros de consulta de solicitud

Parámetros del cuerpo de la solicitud

Respuesta

Documento de respuesta

results Documento incrustado

Nota

Ejemplo de solicitud

Ejemplo de respuesta

Encabezado de respuesta

Cuerpo de respuesta

Nota

`results` Documento incrustado