La configuración de automatización de un proyecto determina el estado objetivo de sus procesos y agentes de MongoDB. El MongoDB Agent construye la implementación de acuerdo con los objetivos especificados.
Importante
La configuración de automatización de un proyecto puede contener información delicada, incluyendo contraseñas o valores clave. Para obtener la configuración de automatización con la información sensible omitida, utiliza el endpoint /groups/{PROJECT-ID}/automationConfig/noSecrets.
Roles necesarios
Este recurso requiere el rol de Project Automation Admin.
Resource
URL base: https://cloud.mongodb.com/api/public/v1.0
GET /groups/{PROJECT-ID}/automationConfig
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 muestra si el cuerpo de la respuesta debe estar en formato prettyprint. |
| ||||||
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 del cuerpo
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
Respuesta
Para revisar estos parámetros, consulta los Parámetros de Configuración de Automatización.
Solicitud de ejemplo
curl --user "{publicApiKey}:{privateApiKey}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/automationConfig?pretty=true" \ --output currentAutomationConfig.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, consulta Ejemplo de configuración de automatización.