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.
Importante
La configuración de automatización de un proyecto puede contener información confidencial, como contraseñas o valores de clave. Para obtener la configuración de automatización con información confidencial censurada, utilice el punto de conexión /groups/{PROJECT-ID}/automationConfig/noSecrets.
Roles necesarios
Este recurso requiere el Project Automation Admin role.
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 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 Los clientes de laAPI no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. Para los puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:
|
|
Parámetros corporales
Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.
Respuesta
Para revisar estos parámetros, consulta los Parámetros de Configuración de Automatización.
Ejemplo de solicitud
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
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.