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 de organización cuya información deseas recuperar. |
Parámetros de Solicitud Query
Los siguientes parámetros de query son opcionales:
Nombre | Tipo | Descripción | predeterminado |
|---|---|---|---|
| entero | Número de página (basado en 1). |
|
| entero | Número de elementos a devolver por página, hasta un máximo de 500. |
|
| booleano | Muestra la respuesta en una pretty-print formato. |
|
| booleano | Especifica si se debe envolver la respuesta en un envelope. |
|
| string | etiqueta legible por humanos del Proyecto para utilizar en el filtro de la lista devuelta. Realiza una búsqueda que no diferencia entre mayúsculas y minúsculas de un proyecto, que está precedido por el Por ejemplo, si especifica un parámetro de consulta | Ninguno |
Parámetros del cuerpo de la solicitud
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
Respuesta
Documento de respuesta
La respuesta El documento JSON incluye un arreglo de result objetos, una matriz de link objetos y un recuento del número total de result objetos 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 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 hosts y el número 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 | La cantidad de hosts primarios en el clúster. |
hostCounts.secundario | entero | El número de hosts secundarios en el clúster. |
ID | string | El identificador único del proyecto. |
enlaces | objeto arreglo | Uno o más enlaces a subrecursos y/o recursos relacionados. Todos los |
Nombre | string | El nombre del clúster. |
orgId | string | El identificador único para la organización principal del proyecto. |
publicApiEnabled | booleano | El estado del acceso a la API en el clúster. |
recuento de réplicaSet | 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. |
Solicitud de ejemplo
curl --user "{username:apiKey}" \ --include \ --header "Content-Type: application/json" \ --digest GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/groups"
Respuesta de ejemplo
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}
Respuesta del cuerpo
{ "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 }