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/monitoringAgentConfig
Solicitud
Parámetros de ruta
Nombre | Tipo | Necesidad | Descripción |
|---|---|---|---|
PROJECT-ID | string | Requerido | Cadena 24de dígitos hexadecimales única que identifica el proyecto propietario de 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. |
| ||||||
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
Parameter | Tipo | Necesidad | Descripción | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Anulaciones de configuración | 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 absoluta del archivo donde este agente de MongoDB escribe sus registros. Si no se especifica, el registro se escribe en el error estándar ( | ||||||||||||||||||||||||||||||
logRotate | Objeto | Opcional | Umbrales después de los cuales este agente MongoDB rota el registro de monitoreo. | ||||||||||||||||||||||||||||||
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 | Usuario de MongoDB en la base de datos de la aplicación que administra los registros de monitoreo. 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
1 curl --user "{publicApiKey}:{privateApiKey}" --digest \ 2 --header "Accept: application/json" \ 3 --include \ 4 --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/automationConfig/monitoringAgentConfig?pretty=true" \ 5 --output currentMonitoringConfig.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
1 { 2 "logPath": "/var/log/mongodb-mms-automation/monitoring-agent.log", 3 "logPathWindows": "%SystemDrive%\\MMSAutomation\\log\\mongodb-mms-automation\\monitoring-agent.log", 4 "logRotate": { 5 "sizeThresholdMB": 1000.0, 6 "timeThresholdHrs": 24 7 }, 8 "username": "mms-automation" 9 }