Docs Home

/ /

Configuración global de la aplicación

Docs Home

/ /

Recursos

Configuración global de la aplicación

Docs Home

Gestión

Gerente de Operaciones

API

Recursos

Configuración global de la aplicación

Obtener configuración global de la aplicación

Recupera la configuración global de la aplicación para una instalación de Ops Manager.

Roles necesarios

Para llamar correctamente a este punto de conexión, su clave de API debe tener el rol Global Owner.

Solicitud

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

GET /admin/settings

Parámetros de ruta de solicitud

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

Parámetros de Solicitud Query

Nombre	Tipo	Necesidad	Descripción	predeterminado
bonito	booleano	Opcional	Indicador que muestra si el cuerpo de la respuesta está en formato pretty-print.	`false`
envelope	booleano	Opcional	Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, ajusta envelope=true en la query. Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye: `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

Campo	Tipo	Descripción
`dbProperties`	Objeto	Pares clave-valor de la configuración global de la aplicación almacenados en la base de datos. MongoDB Ops Manager no devuelve la configuración secreta en texto sin formato.
`defaultFileProperties`	Objeto	Pares clave-valor de los archivos de configuración por defecto incluidos con MongoDB Ops Manager. Esta configuración difiere del archivo de anulación de configuración de nivel de instancia.
`instanceOverrides`	Objeto	Configuración de anulación de la base de datos por instancia. Puede leer, pero no actualizar, esta configuración a través de la API pública.
`instanceDetails`	Objeto	Detalles de la instancia asociados con las anulaciones de la base de datos a nivel de instancia.
`secretProperties`	Arreglo de cadenas	Nombres de configuraciones que Ops Manager almacena como valores cifrados en la base de datos. El contenido de esta lista puede cambiar en futuras versiones.

Solicitud de ejemplo

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET \
     "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/settings?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

1 {
2   "dbProperties": {
3     "mms.centralUrl": "https://ops-manager.example.com",
4     "mms.https.CAFile": "/path/to/ca/file"
5   },
6   "defaultFileProperties": {
7     "mms.https.ClientCertificateMode": "none"
8   },
9   "instanceOverrides": {
10     "instance-1": {
11       "reCaptcha.enabled.registration": "false"
12     }
13   },
14   "instanceDetails": {
15     "instance-1": {
16       "om.instance.runtime.availableProcessors": 2
17     }
18   },
19   "secretProperties": [
20     "mms.smtp.password"
21   ]
22 }

Volver

Configuración global de la aplicación

Actualizar configuración.

1	{
2	"dbProperties": {
3	"mms.centralUrl": "https://ops-manager.example.com",
4	"mms.https.CAFile": "/path/to/ca/file"
5	},
6	"defaultFileProperties": {
7	"mms.https.ClientCertificateMode": "none"
8	},
9	"instanceOverrides": {
10	"instance-1": {
11	"reCaptcha.enabled.registration": "false"
12	}
13	},
14	"instanceDetails": {
15	"instance-1": {
16	"om.instance.runtime.availableProcessors": 2
17	}
18	},
19	"secretProperties": [
20	"mms.smtp.password"
21	]
22	}