/ /

Gerente de Operaciones

Actualizar la configuración de la copia de seguridad

Roles necesarios

Este recurso requiere el Project Automation Admin role.

Resource

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

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

Solicitud

Parámetros de ruta

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

false

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:

Nombre	Descripción
Estado	Código de respuestaHTTP
envolvente	Cuerpo de respuesta esperado

false

Parámetros corporales

Parameter

Tipo

Necesidad

Descripción

Anulaciones de configuración

Objeto

Opcional

Lista de ajustes del Agente MongoDB que debe cambiar porque la configuración de la copia de seguridad es diferente a la del Agente MongoDB. Configure esta opción al actualizar de agentes antiguos al Agente MongoDB.

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

ruta de registro

string

Opcional

Ruta absoluta del archivo donde este agente de MongoDB escribe sus registros. Si no se especifica, el registro se escribe en el error estándar (stderr) en sistemas UNIX y Linux, y en el registro de eventos en sistemas Windows.

logRotate

Objeto

Opcional

Umbrales después de los cuales este agente MongoDB rota el registro de respaldo.

logRotate

.sizeThresholdMB

entero

Opcional

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

logRotate

.timeDurationHrs

entero

Opcional

Número de horas después de las cuales este agente MongoDB rota el archivo de registro.

Nombre de usuario

string

Opcional

MongoDB user in the application database that manages the backup logs.

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

Anulaciones de configuración

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

ruta de registro

string

Opcional

logRotate

Objeto

Opcional

Umbrales después de los cuales este agente MongoDB rota el registro de respaldo.

logRotate

.sizeThresholdMB

entero

Opcional

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

logRotate

.timeDurationHrs

entero

Opcional

Número de horas después de las cuales este agente MongoDB rota el archivo de registro.

Nombre de usuario

string

Opcional

MongoDB user in the application database that manages the backup logs.

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

Ejemplo de solicitud

curl --user "{publicApiKey}:{privateApiKey}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request PUT "https://<OpsManagerHost>:<Port>/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"
       }'

Ejemplo de respuesta

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}

Cuerpo de respuesta

Este endpoint devuelve un objeto JSON vacío.

Volver

Obtener la configuración de respaldo

Obtener configuración de monitoreo