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.
Devuelve todos los hosts del proyecto, incluyendo el estado de replicación del miembro del conjunto de réplicas de cada host.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v2.0
Resource
GET /groups/{PROJECT-ID}/hostsRoles necesarios
La clave API que realiza esta solicitud debe tener el rol Project Read Only.
Parámetros de ruta de solicitud
Nombre | Tipo | Necesidad | Descripción |
|---|---|---|---|
PROJECT-ID | string | Requerido | string única de 24 dígitos hexadecimales que identifica tu proyecto. |
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. |
|
elementosPorPágina | Número | Opcional | Número de elementos a devolver por página, hasta un máximo de 500. |
|
bonito | booleano | Opcional | Indicador que señala si el cuerpo de la respuesta debe estar en formato prettyprint. |
|
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 corregir esto, establezca Para los endpoints que devuelven una lista de resultados, el objeto |
|
Nombre | Tipo | Necesidad | Descripción | predeterminado |
|---|---|---|---|---|
clusterId | string | Opcional | Devuelve solo los hosts de este clúster. | Ninguno |
Parámetros del cuerpo de la solicitud
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
Respuesta
Documento de respuesta
El JSON documento de respuesta incluye un arreglo de objetos result, un arreglo de objetos link y un recuento del número total de objetos result recuperados.
Nombre | Tipo | Descripción |
|---|---|---|
| arreglo | El arreglo incluye un objeto para cada elemento detallado en la sección del |
| 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. |
| 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 y contiene los mismos campos que el v1.0 endpoint.
Nombre | Tipo | Descripción |
|---|---|---|
aliases | Arreglo de cadenas | Arreglo de combinaciones alternativas de nombre de host y puerto que Ops Manager descubrió para el proceso de MongoDB. Estas combinaciones pueden incluir nombres de host, FQDNs, IPv4 direcciones, y IPv6 direcciones. |
alertsEnabled | booleano |
|
authMechanismName | string | Mecanismo de autenticación utilizado para conectar a este proceso de MongoDB. Esto muestra sólo uno de los siguientes valores:
|
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 |
|
ocultos | booleano |
|
hiddenSecondary | booleano |
|
hostEnabled | booleano |
|
Nombre del host | string | Hostname primario según lo que MongoDB Ops Manager pueda determinar mejor. 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 | IPv4 o IPv6 dirección asociada con el |
registradores activados | booleano |
|
lastDataSizeBytes | Número | Tamaño no comprimido de las bases de datos del host en disco en bytes, excluyendo los índices. |
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 ISO 8601 formato de fecha y hora en UTC cuando este proceso se reinició por última vez. Si el proceso de MongoDB nunca se ha reiniciado, se omite el campo |
enlaces | arreglo | Arreglo que incluye uno o más enlaces a subrecursos y/o recursos relacionados. Las relaciones entre URL se explican en la Especificación de Enlaces Web. Como mínimo, un arreglo de |
logsEnabled | booleano |
|
lowUlimit | booleano |
|
Puerto | Número | Puerto en el que escucha el proceso de MongoDB. |
profilerEnabled | booleano |
|
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 |
sslEnabled | booleano |
|
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:
El tipo para los nuevos hosts añadidos a Ops Manager será |
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. |
El v2.0 endpoint también devuelve los siguientes campos para cada host.
Nombre | Tipo | Descripción |
|---|---|---|
tooStale | booleano |
|
lastReplError | string | El último error de replicación del miembro, desde el campo |
Ambos campos describen la entrada de miembro de cada host en su conjunto de réplicas, no el conjunto completo de réplicas. Ops Manager los omite para hosts que no son miembros del conjunto de réplicas y omite lastReplError cuando el miembro no informa de error.
Solicitud de ejemplo
El siguiente ejemplo recupera todos los hosts del proyecto.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v2.0/groups/{PROJECT-ID}/hosts?pretty=true"Respuesta de ejemplo
Encabezado de respuesta
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}Respuesta del cuerpo
El documento se recorta para mayor concidencia. Ops Manager devuelve los documentos completos del host.
{ "links": [ { "href": "https://<OpsManagerHost>:<Port>/api/public/v2.0/groups/5c8100bcf2a30b12ff88258f/hosts?pageNum=1&itemsPerPage=100", "rel": "self" } ], "results": [ { "id": "5f5f8e2b1c9d440b8c1a2b3c", "groupId": "5c8100bcf2a30b12ff88258f", "clusterId": "5e84bd8c87d9d6044a1d76c5", "hostname": "node1.example.com", "port": 27017, "replicaSetName": "rs0", "replicaStateName": "RECOVERING", "tooStale": true, "lastReplError": "error RS102 too stale to catch up", "links": [ { "href": "https://<OpsManagerHost>:<Port>/api/public/v2.0/groups/5c8100bcf2a30b12ff88258f/hosts/5f5f8e2b1c9d440b8c1a2b3c", "rel": "self" }, { "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/5c8100bcf2a30b12ff88258f", "rel": "http://mms.mongodb.com/group" } ] } ], "totalCount": 1}Códigos de respuesta
HTTP Status | Código de error | Descripción |
|---|---|---|
200 | -- | Devuelve la lista paginada de documentos anfitrión. |
Otros códigos de respuesta coinciden con el1v.0 endpoint.