/ /

Automatización

Recurso de configuración

Recurso de configuración

Actualizar la configuración de la copia de seguridad

Roles necesarios

Este recurso requiere el rol de Project Automation Admin.

Resource

URL base: https://cloud.mongodb.com/api/public/v1.0

PUT /groups/{PROJECT-ID}/automationConfig/backupAgentConfig

Solicitud

Parámetros de ruta

Nombre	Tipo	Necesidad	Descripción
PROJECT-ID	string	Requerido	string única de 24dígitos hexadecimales que identifica el proyecto que es propietario de la configuració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.

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:

Nombre	Descripción
`status`	Código de respuesta HTTP
`content`	Cuerpo de respuesta esperado

false

Parámetros del cuerpo

Parameter

Tipo

Necesidad

Descripción

configOverrides

Objeto

Opcional

Lista de configuración del MongoDB Agent que debe cambiar porque su configuración de copia de seguridad difiere de la del MongoDB Agent. Configura esta opción cuando actualices desde agentes heredados al MongoDB Agent.

Configuración	Tipo de dato
`mmsGroupId`	string
`mmsApiKey`	string
`mothership`	string
`mothershipResponseHeaderTimeout`	entero
`https`	booleano
`httpProxy`	string
`krb5Principal`	string
`krb5Keytab`	string
`krb5ConfigLocation`	string
`gsapiServiceName`	string
`sslClientCertificate`	string
`sslClientCertificatePassword`	string
`sslTrustedServerCertificates`	string
`sslRequireValidServerCertificates`	booleano
`sslTrustedMMSBackupServerCertificate`	string

logPath

string

Opcional

Ruta de archivo absoluta en la que este MongoDB Agent escribe sus registros. Si esto no se especifica, el registro se escribe en el estándar de errores (stderr) en sistemas basados en UNIX y Linux y en el Registro de Eventos en sistemas Windows.

logRotate

Objeto

Opcional

Umbrales tras los cuales este MongoDB Agent rota el registro de copia de seguridad.

logRotate
.sizeThresholdMB

entero

Opcional

Tamaño máximo, en MB, de un archivo de registro antes de que este MongoDB Agent rote los registros.

Registro Rotar.tiempo DuraciónHrs

entero

Opcional

Número de horas después de las cuales este MongoDB Agent rota la entrada de registro.

Nombre de usuario

string

Opcional

Usuario de MongoDB en la base de datos de la aplicación que gestiona los registros de copia de seguridad.

Si utilizas la API para habilitar la autenticación para el MongoDB Agent, establece este parámetro en mms-automation al ejecutar este endpoint.

Respuesta

Parameter

Tipo

Necesidad

Descripción

configOverrides

Objeto

Opcional

Configuración	Tipo de dato
`mmsGroupId`	string
`mmsApiKey`	string
`mothership`	string
`mothershipResponseHeaderTimeout`	entero
`https`	booleano
`httpProxy`	string
`krb5Principal`	string
`krb5Keytab`	string
`krb5ConfigLocation`	string
`gsapiServiceName`	string
`sslClientCertificate`	string
`sslClientCertificatePassword`	string
`sslTrustedServerCertificates`	string
`sslRequireValidServerCertificates`	booleano
`sslTrustedMMSBackupServerCertificate`	string

logPath

string

Opcional

logRotate

Objeto

Opcional

Umbrales tras los cuales este MongoDB Agent rota el registro de copia de seguridad.

logRotate
.sizeThresholdMB

entero

Opcional

Tamaño máximo, en MB, de un archivo de registro antes de que este MongoDB Agent rote los registros.

Registro Rotar.tiempo DuraciónHrs

entero

Opcional

Número de horas después de las cuales este MongoDB Agent rota la entrada de registro.

Nombre de usuario

string

Opcional

Usuario de MongoDB en la base de datos de la aplicación que gestiona los registros de copia de seguridad.

Si utilizas la API para habilitar la autenticación para el MongoDB Agent, establece este parámetro en mms-automation al ejecutar este endpoint.

Solicitud de ejemplo

curl --user "{publicApiKey}:{privateApiKey}" --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/backupAgentConfig?pretty=true" \
     --data '{
       "configOverrides" : {
         "mmsBaseUrl" : "http://new.example.org"
       },
       "logPath": "/var/log/mongodb-mms-automation/backup-agent.log",
       "logRotate": {
         "sizeThresholdMB": 1000,
         "timeThresholdHrs": 12
       },
       "username": "mms-automation"
     }'

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

Este endpoint devuelve un objeto JSON vacío.

Volver

Obtener configuraciones de copia de seguridad

Obtener la configuración de supervisión