URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /orgs/{ORG-ID}/groups
Request Parameters
Parámetros de la ruta de solicitud
Elemento de ruta | Tipo | Descripción |
|---|---|---|
ORG-ID | Requerido. | El identificador único para el organización cuya información desea recuperar. |
Parámetros de consulta de solicitud
Los siguientes parámetros de consulta son opcionales:
Nombre | Tipo | Descripción | predeterminado |
|---|---|---|---|
| entero | Número de página (basado en 1). |
|
| entero | Número de artículos a devolver por página, hasta un máximo de 500. |
|
| booleano | Muestra la respuesta en un impresión bonita formato. |
|
| booleano | Especifica si se debe envolver o no la respuesta en un sobre. |
|
| string | Etiqueta legible del proyecto que se usará para filtrar la lista devuelta. Realiza una búsqueda sin distinción entre mayúsculas y minúsculas de un proyecto con el prefijo Por ejemplo, si especifica un parámetro de consulta | Ninguno |
Parámetros del cuerpo de la solicitud
Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.
Respuesta
Documento de respuesta
La respuesta El documentoJSON 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 |
|---|---|---|
| arreglo | La matriz incluye un objeto para cada elemento detallado en la |
| 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. |
| 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 proyecto.
Nombre | Tipo | Descripción |
|---|---|---|
activeAgentCount | entero | La cantidad de monitoreo, automatización y copias de seguridad activas en el proyecto. |
hostCounts | Documento | Describe los tipos de host y la cantidad de cada tipo de host para el clúster. |
hostCounts.árbitro | entero | El número de hosts árbitros en el clúster. |
hostCounts.config | entero | La cantidad de hosts de servidor de configuración de clúster fragmentado en el clúster. |
hostCounts.mongos | entero | La cantidad de hosts mongos en el clúster. |
hostCounts.primario | entero | El número de hosts principales en el clúster. |
hostCounts.secundario | entero | |
ID. | string | El identificador único del proyecto. |
enlaces | matriz de objetos | Uno o más enlaces a subrecursos o recursos relacionados. Todas las |
Nombre | string | El nombre del cluster. |
orgId | string | El identificador único de la organización principal del proyecto. |
publicApiEnabled | booleano | El estado del acceso de la API al clúster. |
recuento de conjuntos de réplicas | entero | El número de conjuntos de réplicas en el clúster. |
recuento de fragmentos | entero | La cantidad de fragmentos en el clúster. |
Ejemplo de solicitud
curl --user "{username:apiKey}" \ --include \ --header "Content-Type: application/json" \ --digest GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/groups"
Ejemplo de respuesta
Encabezado de respuesta
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
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
{ "links": [ { } ], "results": [ { "activeAgentCount": 0, "hostCounts": { "arbiter": 0, "config": 0, "mongos": 0, "primary": 1, "secondary": 2 }, "id": "{PROJECT-ID}", "links": [ { } ], "name": "Production Cluster", "orgId": "{ORG-ID}", "publicApiEnabled": true, "replicaSetCount": 1, "shardCount": 0 }, { "activeAgentCount": 0, "hostCounts": { "arbiter": 0, "config": 0, "mongos": 0, "primary": 1, "secondary": 2 }, "id": "{PROJECT-ID}", "lastActiveAgent": "2017-10-26T02:39:59Z", "links": [ { } ], "name": "Staging Cluster", "orgId": "{ORG-ID}", "publicApiEnabled": true, "replicaSetCount": 1, "shardCount": 0 } ], "totalCount": 2 }