Roles necesarios
Este recurso requiere el rol de Project Automation Admin.
Resource
URL base: https://cloud.mongodb.com/api/public/v1.0
GET /groups/{PROJECT-ID}/automationConfig/monitoringAgentConfigSolicitud
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 se debe devolver el cuerpo de la respuesta en un prettyprint formato. |
|
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, establezca envelope=true en la query. Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:
|
|
Parámetros del cuerpo
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
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.
|
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 ( |
logRotate | Objeto | Opcional | Umbrales tras los que este MongoDB Agent rota el registro de supervisión. |
logRotate | entero | Opcional | Tamaño máximo, en MB, de un archivo de registro antes de que este MongoDB Agent rote los registros. |
logRotate | 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 utiliza la API para habilitar la autenticación del agente MongoDB, configure este parámetro como mms-automation al ejecutar este endpoint. |
Solicitud de ejemplo
curl --user "{publicApiKey}:{privateApiKey}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/automationConfig/monitoringAgentConfig?pretty=true" \ --output currentMonitoringConfig.jsonRespuesta de ejemplo
Encabezado de respuesta
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}Respuesta del cuerpo
{ "logPath": "/var/log/mongodb-mms-automation/monitoring-agent.log", "logPathWindows": "%SystemDrive%\\MMSAutomation\\log\\mongodb-mms-automation\\monitoring-agent.log", "logRotate": { "sizeThresholdMB": 1000.0, "timeThresholdHrs": 24 }, "username": "mms-automation"}