Un proyecto La configuración de automatización determina el estado objetivo de sus procesos y agentes MongoDB. El agente MongoDB crea la implementación según los objetivos especificados.
Una configuración de automatización podría contener información confidencial, como contraseñas y valores de claves. Este recurso te permite actualizar la configuración de automatización de un proyecto sin actualizar ningún campo que contenga información confidencial.
PUT las solicitudes al endpoint /groups/{PROJECT-ID}/automationConfig/noSecrets ignoran cualquier campo en la configuración de automatización en el cuerpo de la solicitud que contenga información sensible, dejando sus valores actuales sin cambios y actualizando todos los demás campos. Para actualizar la configuración completa de automatización, incluyendo cualquier información sensible, usa el /groups/{ID del grupo}/automationConfig endpoint.
Para actualizar la configuración:
Recuperar la configuración actual.
Puedes usar el endpoint /groups/{ID del grupo}/automationConfig para obtener la configuración completa, o el endpoint /groups/{ID del grupo}/automationConfig/noSecrets para obtener la configuración con información confidencial redactada, como contraseñas o valores clave.
Haz cambios en una copia de la configuración actual, cambiando solo aquellos elementos que deseas modificar.
Reemplace toda la configuración usando
PUT, con la configuración actualizada en el cuerpo de la solicitud. Debe utilizarPUT. No utilizarPATCH.Cuando envías actualizaciones, Cloud Manager realiza modificaciones internas en los datos y luego guarda tu nueva versión de configuración.
Nota
Algunos parámetros no pueden actualizarse a través del endpoint automationConfig. Para obtener más información, consulte:
Para realizar actualizaciones al Agente MongoDB que no hostnamesean, debe hacerlo a través de un punto final diferente.
Para ver un tutorial sobre cómo actualizar una configuración de automatización, consulte Tutorial de recursos para actualizar la configuración de automatización.
Los agentes de MongoDB consultan continuamente a Cloud Manager en busca de cambios en la configuración y obtienen actualizaciones de configuración cuando ocurren. Luego, los agentes ajustan los estados de sus procesos activos para que coincidan.
Advertencia
Realizar cambios en la configuración de automatización con una solicitud PUT puede provocar tiempo de inactividad del clúster. Prueba los cambios en entornos inferiores antes de aplicarlos a entornos de producción.
Advertencia
No existe ninguna protección en la API de administración de Cloud Manager para impedir las modificaciones simultáneas. Si dos administradores comienzan con una configuración basada en la versión actual, realizan sus propias modificaciones y después envían sus cambios, la última modificación enviada prevalece.
Advertencia
Actualizar el nombre de usuario del agente antes de habilitar la autenticación
La configuración de automatización proporciona el único medio para habilitar la autenticación en tus clústeres usando el API. Para habilitar la autenticación, primero llama a los siguientes endpoints con "nombre de usuario": "mms-automation":
Roles necesarios
Este recurso requiere el Project Automation Admin rol.
Resource
URL base: https://cloud.mongodb.com/api/public/v1.0
PUT /groups/{PROJECT-ID}/automationConfig/noSecrets
Solicitud
Parámetros de ruta
Nombre | Tipo | Necesidad | Descripción |
|---|---|---|---|
PROJECT-ID | string | Requerido | Identificador único del grupo que posee la configuración de automatización. |
Parámetros de query
Los siguientes parámetros de query son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
bonito | booleano | Opcional | Indicador que señala si el cuerpo de 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 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:
|
|
Parámetros corporales
Para revisar estos parámetros, consulta los Parámetros de Configuración de Automatización.
Respuesta
Para revisar estos parámetros, consulta los Parámetros de Configuración de Automatización.
Solicitud de ejemplo
Lo siguiente reemplaza la configuración de automatización con la configuración actualizada guardada en /Users/admin/updated-conf.json. Para ver un ejemplo de un documento de configuración actualizado, consulte Ejemplo de configuración de automatización.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request PUT "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/automationConfig/noSecrets?pretty=true" \ --data-binary "@/Users/admin/updated-conf.json"
Respuesta de ejemplo
Encabezado de respuesta
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
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
Para revisar un ejemplo de esta configuración, consulte Ejemplo de configuración de automatización.