/ /

Recursos

Configuración global de la aplicación

Docs Home

Gestión

Gerente de Operaciones

API

Recursos

Configuración global de la aplicación

Actualizar la configuración global de la aplicación

Actualiza la configuración global de la aplicación para una instalación de Ops Manager. Incluya solo la configuración que desee cambiar. Ops Manager deja todas las demás configuraciones sin cambios.

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

PATCH /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

Campo	Tipo	Necesidad	Descripción
`dbProperties`	Objeto	Requerido	Pares clave-valor de la configuración global de la aplicación para actualizar o agregar. La configuración no incluida en la solicitud permanece sin cambios. Para remover una configuración, establezca su valor en `null`.

Importante

Ops Manager rechaza cualquier solicitud que incluya mms.app.upgradeMode, independientemente del valor. Estas solicitudes devuelven un error 400 con el código de error INVALID_SETTINGS_EXCEPTION.

La validación se ejecuta en el conjunto combinado de configuraciones existentes y enviadas, no solo en las propiedades enviadas. Una solicitud puede fallar en un campo que no incluyó si ese campo es una dependencia de una configuración que envió y aún no está configurado. Por ejemplo, el envío de {"mms.emailDaoClass": "SIMPLE_MAILER"} falla con detail: "mms.mail.hostname must not be blank" si mms.mail.hostname no tiene un valor existente.

Respuesta

Campo	Tipo	Descripción
`restartRequired`	booleano	Indica si debe reiniciar Ops Manager para que la configuración actualizada surta efecto.

Solicitud de ejemplo

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request PATCH \
     "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/settings?pretty=true" \
     --data '{
       "dbProperties": {
         "mms.centralUrl": "https://ops-manager.example.com"
       }
     }'

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   "restartRequired": false
3 }

Volver

Obtener configuración

Administración de copias de seguridad