/ /

Gerente de Operaciones

Recuperar un proyecto por clave API del agente

Nota

Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} es el mismo que tu id. de proyecto. Para los grupos existentes, su ID de grupo/ID del grupo seguirá siendo el mismo. Esta página utiliza el término más familiar grupo al referirse a descripciones. El endpoint se mantiene tal como se indica en el documento.

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

GET /groups/byAgentApiKey/{AGENT-API-KEY}

Request Parameters

Parámetros de la ruta de solicitud

Nombre	Tipo	Descripción
clave API del agente	string	(Obligatorio.) El clave API del agente

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 respuesta debe estar en un prettyprint formato.

false

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:

Nombre	Descripción
`status`	Código de respuesta HTTP
`content`	Cuerpo de respuesta esperado

false

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 activeAgentCount.

hostCounts

Objeto

Número total de hosts por tipo. Los campos incrustados deberían ser autoexplicativos.

string

Identificador único para el proyecto.

último agente activo

string

Hora de la última actualización del total de activeAgentCount para el proyecto por parte de Ops Manager. Ops Manager actualiza este valor cada 24 horas y lo almacena en caché para registrar la cantidad de agentes MongoDB activos.

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 roleName es la siguiente:

Rol del usuario	`roleName` Valor
`Project Owner` (obligatorio)	`GROUP_OWNER`
`Project Automation Admin`	`GROUP_AUTOMATION_ADMIN`
`Project Backup Admin`	`GROUP_BACKUP_ADMIN`
`Project Monitoring Admin`	`GROUP_MONITORING_ADMIN`
`Project Data Access Admin`	`GROUP_DATA_ACCESS_ADMIN`
`Project Data Access Read/Write`	`GROUP_DATA_ACCESS_READ_WRITE`
`Project Data Access Read Only`	`GROUP_DATA_ACCESS_READ_ONLY`
`Project Read Only`	`GROUP_READ_ONLY`

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 y/o recursos relacionados. Todos los links arreglos en las respuestas incluyen al menos un enlace llamado self. Las relaciones entre URLs se explican en la Especificación de Enlaces Web.

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á true.

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.

Para ver las etiquetas debes tener el Project Read Only rol.
Para crear o editar etiquetas debes tener el Project Automation Admin rol.

Un proyecto puede tener hasta 10 etiquetas. Las etiquetas siguen estas reglas:

Son sensibles a mayúsculas y minúsculas
Puede contener estos caracteres:
- A a través de Z
- 0 a través de 9
- . (punto)
- _ (subrayar)
- - (dash)
Están limitados a 32 caracteres

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/byAgentApiKey/{AGENT-API-KEY}?pretty=true"

Respuesta de ejemplo

Encabezado de respuesta

HTTP/1.1 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

HTTP/1.1 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

{
  "id": "{PROJECT-ID}",
  "name": "My Project",
  "orgId" : "{ORG-ID}",
  "hostCounts": {
    "arbiter": 2,
    "config": 1,
    "primary": 4,
    "secondary": 8,
    "mongos": 2
  },
  "lastActiveAgent": ISODate("2016-08-05T07:23:34Z"),
  "activeAgentCount": 1,
  "replicaSetCount": 3,
  "shardCount": 2,
  "publicApiEnabled": true,
  "tags": [ "DEV", "PRODUCT" ],
  "ldapGroupMappings" : [ {
    "roleName": "GROUP_OWNER",
    "ldapGroups": [  "project-owner" ]
    }, ... ],
  "links" : []
}

Volver

Obtener por nombre

Crear