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/monitoringAgentConfig
Solicitud
Parámetros de ruta
Nombre | Tipo | Necesidad | Descripción |
|---|---|---|---|
PROJECT-ID | string | Requerido | Unique 24-hexadecimal digit string that identifica el proyecto que posee 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 señala si el cuerpo de respuesta debe estar en un prettyprint formato. |
| ||||||
envelope | 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 endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:
|
|
Parámetros corporales
Para cambiar estos ajustes con el agente de MongoDB, incluya uno o más de estos parámetros en el cuerpo de la solicitud.
Parameter | Tipo | Necesidad | Descripción | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
configOverrides | Objeto | Opcional | Lista de configuraciones del Agente MongoDB que debes cambiar porque tu configuración de supervisión difiere de la del MongoDB Agent. Configura esta opción al actualizar de agentes heredados al agente MongoDB.
| ||||||||||||||||||||||||||||||
ruta de registro | 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 ( | ||||||||||||||||||||||||||||||
logRotate | Objeto | Opcional | Umbrales tras los que este MongoDB Agent rota el registro de supervisión. | ||||||||||||||||||||||||||||||
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 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 supervisión. 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 | Lista de configuraciones del Agente MongoDB que debes cambiar porque tu configuración de supervisión difiere de la del MongoDB Agent. Configura esta opción al actualizar de agentes heredados al agente MongoDB.
| ||||||||||||||||||||||||||||||
ruta de registro | 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 ( | ||||||||||||||||||||||||||||||
logRotate | Objeto | Opcional | Umbrales tras los que este MongoDB Agent rota el registro de supervisión. | ||||||||||||||||||||||||||||||
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 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 supervisión. 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
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --include \ 5 --request PUT "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/automationConfig/monitoringAgentConfig" 6 --data '{ 7 "configOverrides" : { 8 "mmsBaseUrl" : "http://new.example.org" 9 }, 10 "logPath": "/var/log/mongodb-mms-automation/monitoring-agent.log", 11 "logRotate": { 12 "sizeThresholdMB": 1000, 13 "timeThresholdHrs": 12 14 }, 15 "username": "mms-automation" 16 }'
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}
Respuesta del cuerpo
Este endpoint devuelve un objeto JSON vacío.