Join us at MongoDB.local London on 7 May to unlock new possibilities for your data. Use WEB50 to save 50%.
Register now >
Docs Menu
Docs Home
/ /

Root (raíz)

El recurso root es el punto de partida para la API de Ops Manager. Desde aquí, puedes atravesar el links para acceder a todos los demás recursos de la API.

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

GET /

Este endpoint no utiliza parámetros de ruta de solicitud HTTP.

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.

1

elementosPorPágina

Número

Opcional

Número de elementos a devolver por página, hasta un máximo de 500.

100

bonito

booleano

Opcional

Bandera que indica si el cuerpo de la respuesta debe estar en una pretty-print formato.

false

envelope

booleano

Opcional

Bandera que indica si se debe o no envolver la respuesta en un sobre.

Algunos Los clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para remediarlo, establezca envelope : true en la query.

Para los endpoints que devuelven una lista de resultados, el objeto content es un sobre. Ops Manager agrega el campo status al cuerpo de la respuesta.

false

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

La respuesta incluye:

Nombre
Tipo
Descripción

appName

string

MongoDB Ops Manager

compilar

string

El SHA que corresponde al commit de GitHub para el Ops Manager.

enlaces

objeto arreglo

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

regulación

booleano

El campo está obsoleto y tiene el valor false.

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
--header 'Accept: application/json' \
--include \
--request GET "<ops-manager-host>:<port>/api/public/v1.0"
{
"appName" : "MongoDB Ops Manager",
"build" : "ec8b09b880be314981caa9d8fbefc3280056522e",
"links" : [
],
"throttling" : false
}

Volver

Recursos

En esta página