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.
Para actualizar la configuración:
Recuperar la configuración actual.
Puede utilizar el punto final /groups/{PROJECT-ID}/automationConfig para obtener la configuración completa, o el punto final /groups/{PROJECT-ID}/automationConfig/noSecrets para obtener la configuración con información confidencial redactada, como contraseñas o valores de clave.
Realice cambios en una copia de la configuración actual, cambiando sólo aquellos elementos que desee modificar.
Reemplace toda la configuración usando
PUT, con la configuración actualizada en el cuerpo de la solicitud.PUTDebe usar. NoPATCHuse.Cuando envía actualizaciones, Cloud Manager realiza modificaciones internas en los datos y luego guarda su nueva versión de configuración.
Importante
Una configuración de automatización puede contener información confidencial, como contraseñas o valores de clave. Para actualizar la configuración de automatización de un proyecto sin actualizar ningún campo que contenga información confidencial, utilice el punto de conexión /groups/{PROJECT-ID}/automationConfig/noSecrets.
Nota
Algunos parámetros no se pueden actualizar a través del punto final 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 Cloud Manager para detectar cambios en la configuración y obtienen actualizaciones de configuración cuando ocurren. Posteriormente, ajustan el estado de sus procesos activos para que coincidan.
Advertencia
Realizar cambios en la configuración de automatización mediante una solicitud PUT puede provocar tiempo de inactividad del clúster. Pruebe los cambios en entornos inferiores antes de aplicarlos a entornos de producción.
Advertencia
La API de administración de Cloud Manager no ofrece protección para evitar modificaciones simultáneas. Si dos administradores comienzan con una configuración basada en la versión actual, realizan sus propias modificaciones y luego las envían, prevalecerá la última modificación.
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 sus clústeres mediante el API. Para habilitar la autenticación, primero llame a los siguientes puntos finales con "username": "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
Solicitud
Parámetros de ruta
Nombre | Tipo | Necesidad | Descripción |
|---|---|---|---|
PROJECT-ID | string | Requerido | Identificador único del grupo propietario de la configuración de automatización. |
Parámetros de consulta
Los siguientes parámetros de consulta son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
bonita | booleano | Opcional | Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint formato. |
| ||||||
envolvente | 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 ni al código de estado. Para solucionarlo, configure envelope=true en la consulta. Para los puntos finales 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.
Ejemplo de solicitud
A continuación, se reemplaza la configuración de automatización con la configuración actualizada guardada /Users/admin/updated-conf.json en. 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?pretty=true" \ --data-binary "@/Users/admin/updated-conf.json"
Ejemplo de respuesta
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}
Cuerpo de respuesta
Para revisar un ejemplo de esta configuración, consulte Ejemplo de configuración de automatización.