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.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /groups
Request Parameters
Parámetros de ruta de solicitud
Este endpoint no utiliza parámetros de ruta de solicitud HTTP.
Parámetros de Solicitud Query
Nombre | Tipo | Descripción |
|---|---|---|
tag | string | Las etiquetas asignadas al proyecto para su identificación programática.
|
Parámetros del cuerpo de la solicitud
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
Respuesta
Documento de respuesta
El documento de respuesta JSON 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 proyecto.
Nombre | Tipo | Descripción | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
activeAgentCount | entero | Número de agentes activos que envían pings periódicos a Ops Manager. El valor se actualiza aproximadamente cada 24 horas y se almacena en caché. Si comienza un nuevo agente o detiene uno existente, el cambio puede tardar hasta 30 minutos en aparecer en el campo | ||||||||||||||||||
hostCounts | Objeto | Número total de hosts por tipo. Los campos integrados deben ser autoexplicativos. | ||||||||||||||||||
ID | string | Identificador único para el proyecto. | ||||||||||||||||||
lastActiveAgent | string | El Ops Manager actualizó por última vez el total de | ||||||||||||||||||
ldapGroupMappings | objeto arreglo | Para el Ops Manager respaldado por LDAP, los mapeos de grupos de LDAP a roles del proyecto de Ops Manager. Solo está presente para Ops Manager respaldado por LDAP. | ||||||||||||||||||
ldapGroupMappings.roleName | string | Rol de usuario de Ops Manager. La asignación de Rol de proyecto a
| ||||||||||||||||||
ldapGroupMappings.ldapGroups | arreglo de string | Proyecto(s) de LDAP que se corresponden con el rol de Ops Manager. | ||||||||||||||||||
enlaces | objeto arreglo | Uno o más enlaces a subrecursos o recursos relacionados. Todos los arreglos | ||||||||||||||||||
Nombre | string | Nombre para mostrar del proyecto. | ||||||||||||||||||
orgId | string | Identificador único para la organización a la que pertenece el proyecto. | ||||||||||||||||||
publicApiEnabled | booleano | Bandera que indica que la API está habilitada para este proyecto. Este es un campo de solo lectura que siempre está | ||||||||||||||||||
recuento de réplicaSet | entero | Número total de sets de réplicas para este proyecto. | ||||||||||||||||||
shardCount | entero | Número total de particiones en este proyecto. | ||||||||||||||||||
etiqueta | arreglo de string | Etiquetas asignadas al proyecto para su uso en la identificación programática del proyecto.
Un proyecto puede tener hasta 10 etiquetas. Las etiquetas siguen estas reglas:
|
Solicitud de ejemplo
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups?tag=ABC&tag=DEF&pretty=true"
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
1 { 2 "links": [], 3 "results": [{ 4 "id": "xxx", 5 "name": "My Project", 6 "orgId": "111111111cccccf38dc78bdf", 7 "hostCounts": { 8 "arbiter": 2, 9 "config": 1, 10 "primary": 4, 11 "secondary": 8, 12 "mongos": 2 13 }, 14 "lastActiveAgent": "2016-08-05T07:23:34Z", 15 "activeAgentCount": 1, 16 "replicaSetCount": 3, 17 "shardCount": 2, 18 "publicApiEnabled": true, 19 "agentApiKey": "cbd728abd6a6d6c6b6d7826345dbcff0e", 20 "tags": ["ABC", "DEF"], 21 "ldapGroupMappings": [{ 22 "roleName": "GROUP_OWNER", 23 "ldapGroups": [ "project-owner"] 24 }], 25 "links": [] 26 } 27 ], 28 "totalCount": 1 29 }