/ /

Gerente de Operaciones

Obtenga una clave API de proyecto por agente

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 tu grupo/proyecto permanece igual. Esta página utiliza el término "grupo" para 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/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 consulta de solicitud

Los siguientes parámetros de consulta son opcionales:

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonita

booleano

Opcional

Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint formato.

false

envolvente

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 puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:

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

false

Parámetros del cuerpo de la solicitud

Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.

Respuesta

Nombre

Tipo

Descripción

activeAgentCount

entero

Número de agentes activos que envían pings regulares a Ops Manager.

El valor se actualiza aproximadamente cada 24 horas y se almacena en caché. Si inicia 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.

ID.

string

Identificador único del proyecto.

último agente activo

string

Hora de la última actualización del total de activeAgentCount para el proyecto. 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

matriz de objetos

Para Ops Manager respaldado por LDAP, las asignaciones de Grupos LDAP para roles de proyecto de Ops Manager. Solo disponible para Ops Manager con respaldo LDAP.

ldapGroupMappings

.roleName

string

Rol de usuario de Ops Manager. La asignación de Rol de proyecto a roleName es la siguiente:

Rol de 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

matriz de cadenas

Proyecto(s) LDAP que se asignan al rol de Administrador de operaciones.

enlaces

matriz de objetos

Uno o más enlaces a subrecursos o recursos relacionados. Todas las links matrices en las respuestas incluyen al menos un enlace self llamado. Las relaciones entre las URLse explican en la Especificación de Enlaces Web.

Nombre

string

Nombre para mostrar del proyecto.

orgId

string

Identificador único de la organización a la que pertenece el proyecto.

publicApiEnabled

booleano

Indicador que indica que la API está habilitada para este proyecto. Este campo es de solo lectura y siempre true es.

recuento de conjuntos de réplicas

entero

Número total de conjuntos de réplicas para este proyecto.

recuento de fragmentos

entero

Número total de fragmentos para este proyecto.

Etiquetas

matriz de cadenas

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
- . (período)
- _ (subrayar)
- - (dash)
Están limitados a 32 caracteres

Ejemplo de solicitud

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"

Ejemplo de respuesta

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}

Cuerpo de respuesta

{
  "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