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/byName/{GROUP-NAME}
Request Parameters
Parámetros de la ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
NOMBRE DEL GRUPO | string | (Obligatorio.) El nombre del proyecto. |
Parámetros de Solicitud Query
Los siguientes parámetros de query son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
bonito | booleano | Opcional | Indicador que señala si el cuerpo de la respuesta debe estar en un 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 envelope=true en la consulta. Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:
|
|
Parámetros del cuerpo de la solicitud
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
Respuesta
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 el gestor de operaciones respaldado por LDAP, las asignaciones de Grupos LDAP en los roles del proyecto de Ops Manager. Solo está presente en Ops Manager respaldados 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. 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
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --include \ --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups/byName/{GROUP-NAME}?pretty=true"
Importante
Algunos caracteres no están permitidos en las URLs. Esto se denomina caracteres reservados. Si tu {GROUP-NAME} incluye caracteres reservados, como espacios, debes reemplazarlos con su codificación por porcentaje.
Por ejemplo, en lugar de hacer esta solicitud (a través de curl):
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/byName/My%20Project?pretty=true"
Haga esta solicitud (a través de curl):
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/byName/My%20Group?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
{ "activeAgentCount": 1, "hostCounts": { "arbiter": 2, "config": 1, "primary": 4, "secondary": 8, "mongos": 2 }, "id": "{PROJECT-ID}", "ldapGroupMappings" : [ { "roleName": "GROUP_OWNER", "ldapGroups": [ "project-owner" ] }, ... ], "lastActiveAgent": ISODate("2016-08-05T07:23:34Z"), "links" : [], "name": "My Project", "orgId" : "111111111cccccf38dc78bdf", "publicApiEnabled": true, "replicaSetCount": 3, "shardCount": 2, "tags": [ "DEV", "PRODUCT" ] }