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 grupo/proyecto permanece igual. Esta página utiliza el término más familiar «grupo» al referirse a las descripciones. El punto final se mantiene como se indica en el documento.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /groups
Request Parameters
Parámetros de la ruta de solicitud
Este endpoint no utiliza parámetros de ruta de solicitud HTTP.
Parámetros de Solicitud Query
Los siguientes parámetros de query son opcionales:
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 | Bandera que indica si el cuerpo de la respuesta debe estar en una pretty-print formato. |
|
envelope | 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 Para los endpoints que devuelven una lista de resultados, el objeto |
|
Parámetros del cuerpo de la solicitud
Este endpoint no utiliza parámetros de cuerpo de 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 |
|---|---|---|
| arreglo | La matriz incluye un objeto para cada elemento detallado en el
Sección |
| 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 incrustados deberían ser autoexplicativos. | ||||||||||||||||||
ID | string | Identificador único para el proyecto. | ||||||||||||||||||
último agente activo | string | Hora de la última actualización del total de | ||||||||||||||||||
Asignaciones de grupos ldap | objeto arreglo | Para Ops Manager con respaldo LDAP, las asignaciones de grupos LDAP a roles de proyecto de Ops Manager. Solo está presente para Ops Manager con respaldo 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. Todas las | ||||||||||||||||||
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. | ||||||||||||||||||
recuento de fragmentos | entero | Número total de particiones en este proyecto. | ||||||||||||||||||
Etiquetas | 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
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Accept: application/json" \ 3 --include \ 4 --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups?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 "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups?pretty=true&pageNum=1&itemsPerPage=100", 4 "rel": "self" 5 }, { 6 "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups?pretty=true&itemsPerPage=100&pageNum=2", 7 "rel": "next" 8 }], 9 "results": [{ 10 "activeAgentCount": 0, 11 "hostCounts": { 12 "arbiter": 0, 13 "config": 0, 14 "mongos": 0, 15 "primary": 0, 16 "secondary": 0 17 }, 18 "id": "56a10a80e4b0fd3b9a9bb0c2", 19 "lastActiveAgent": "2016-03-09T18:19:37Z", 20 "links": [{ 21 "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}", 22 "rel": "self" 23 }], 24 "name": "012i3091203jioawjioej", 25 "orgId": "5980cfdf0b6d97029d82f86e", 26 "publicApiEnabled": true, 27 "replicaSetCount": 0, 28 "shardCount": 0, 29 "tags": [] 30 }, { 31 "activeAgentCount": 0, 32 "hostCounts": { 33 "arbiter": 0, 34 "config": 0, 35 "mongos": 0, 36 "primary": 0, 37 "secondary": 0 38 }, 39 "id": "56aa691ce4b0a0e8c4be51f7", 40 "lastActiveAgent": "2016-01-29T19:02:56Z", 41 "links": [{ 42 "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}", 43 "rel": "self" 44 }], 45 "name": "1454008603036", 46 "orgId": "5980d0040b6d97029d831798", 47 "publicApiEnabled": true, 48 "replicaSetCount": 0, 49 "shardCount": 0, 50 "tags": [] 51 }, { 52 "activeAgentCount": 0, 53 "hostCounts": { 54 "arbiter": 0, 55 "config": 0, 56 "mongos": 0, 57 "primary": 0, 58 "secondary": 0 59 }, 60 "id": "56aa6dfde4b0fe328eee82ad", 61 "lastActiveAgent": "2016-01-29T20:34:28Z", 62 "links": [{ 63 "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}", 64 "rel": "self" 65 }], 66 "name": "1454009852809", 67 "orgId": "5980d0040b6d97029d831799", 68 "publicApiEnabled": true, 69 "replicaSetCount": 0, 70 "shardCount": 0, 71 "tags": [] 72 }, { 73 "activeAgentCount": 0, 74 "hostCounts": { 75 "arbiter": 0, 76 "config": 0, 77 "mongos": 0, 78 "primary": 0, 79 "secondary": 0 80 }, 81 "id": "56aa8421e4b0d04c1c54df99", 82 "lastActiveAgent": "2016-01-29T21:36:10Z", 83 "links": [{ 84 "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}", 85 "rel": "self" 86 }], 87 "name": "1454015520776", 88 "orgId": "5980d0040b6d97029d83179a", 89 "publicApiEnabled": true, 90 "replicaSetCount": 0, 91 "shardCount": 0, 92 "tags": [] 93 }, { 94 "activeAgentCount": 0, 95 "hostCounts": { 96 "arbiter": 0, 97 "config": 0, 98 "mongos": 0, 99 "primary": 0, 100 "secondary": 0 101 }, 102 "id": "56aa85f9e4b0d04c1c54e347", 103 "lastActiveAgent": "2016-01-29T21:36:10Z", 104 "links": [{ 105 "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}", 106 "rel": "self" 107 }], 108 "name": "1454015992252", 109 "orgId": "5980d0040b6d97029d83179b", 110 "publicApiEnabled": true, 111 "replicaSetCount": 0, 112 "shardCount": 0, 113 "tags": [] 114 }], 115 "totalCount": 5 116 }