El recurso root es el punto de partida para la API de Ops Manager. Desde aquí, puedes recorrer el links para llegar a todos los demás recursos de la API.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /
Parámetros de ruta de solicitud
Este endpoint no utiliza parámetros de ruta de solicitud HTTP.
Parámetros de Solicitud Query
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. |
|
elementosPorPágina | Número | Opcional | Número de elementos a devolver por página, hasta un máximo de 500. |
|
bonito | booleano | Opcional | Indicador que indica si el cuerpo de la respuesta debe estar en un prettyprint formato. |
|
envelope | booleano | Opcional | Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos clientes de API no pueden acceder a los encabezados de respuesta HTTP o al código de estado. Para remediar esto, establezca Para los endpoints que devuelven una lista de resultados, el objeto |
|
Parámetros del cuerpo de la solicitud
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
Respuesta
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 |
regulación | booleano | El campo está obsoleto y tiene el valor |
Solicitud de ejemplo
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --include \ --request GET "<ops-manager-host>:<port>/api/public/v1.0"
Respuesta de ejemplo
{ "appName" : "MongoDB Ops Manager", "build" : "ec8b09b880be314981caa9d8fbefc3280056522e", "links" : [ ], "throttling" : false }