/ /

/ /

Gerente de Operaciones

API

Recursos

Raíz

El recurso raíz es el punto de partida de la API de Ops Manager. Desde aquí, puede recorrer el... links para llegar a todos los demás recursos de API.

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

Resource

GET /

Parámetros de la ruta de solicitud

Este punto final no utiliza parámetros de ruta de solicitud HTTP.

Parámetros de consulta de solicitud

Los siguientes parámetros de consulta son opcionales:

Nombre	Tipo	Necesidad	Descripción	predeterminado
número de página	Número	Opcional	Entero basado en uno que devuelve una subsección de resultados.	`1`
artículos por página	Número	Opcional	Número de artículos a devolver por página, hasta un máximo de 500.	`100`
bonita	booleano	Opcional	Bandera que indica si el cuerpo de la respuesta debe estar en un impresión bonita 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 una lista de resultados, el objeto `content` es un sobre. Ops Manager añade el campo `status` al cuerpo de la respuesta.	`false`

Parámetros del cuerpo de la solicitud

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

Respuesta

La respuesta incluye:

Nombre	Tipo	Descripción
appName	string	MongoDB Ops Manager
construir	string	El SHA que corresponde a la confirmación de GitHub para Ops Manager.
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.
estrangulamiento	booleano	El campo está obsoleto y tiene el valor `false`.

Ejemplo de solicitud

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --include \
 --request GET "<ops-manager-host>:<port>/api/public/v1.0"

Ejemplo de respuesta

{
   "appName" : "MongoDB Ops Manager",
   "build" : "ec8b09b880be314981caa9d8fbefc3280056522e",
   "links" : [
   ],
   "throttling" : false
}

Volver

Recursos

Implementaciones