/ /

Gerente de Operaciones

API

Recursos

Uso del servidor

Obtenga un fichero de diagnóstico de un Proyecto

Los ingenieros de MongoDB pueden solicitar que los administradores de Ops Manager proporcionen ficheros diagnósticos de un Proyecto para depuración y solución de problemas. Los archivos de diagnóstico del proyecto también contienen información global del sistema sobre Ops Manager.

Roles necesarios

La clave de API requiere la Global Monitoring Admin or Global Owner rol para descargar un fichero de diagnóstico.

Resource

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

GET /groups/{PROJECT-ID}/diagnostics

Parámetros de la ruta de solicitud

Nombre	Tipo	Necesidad	Descripción
`PROJECT-ID`	string	Requerido	Identificador único del proyecto propietario del archivo de diagnóstico.

Parámetros de Solicitud Query

Proporciona cualquiera de los siguientes parámetros de query que necesites:

Nombre	Tipo	Necesidad	Descripción	predeterminado
Num. de pág.	Número	Opcional	Entero basado en uno que devuelve una subsección de resultados.	`1`
elementosPorPágina	Número	Opcional	Número de elementos a devolver por página, hasta un máximo de 500.	`100`
bonito	booleano	Opcional	Bandera que indica si el cuerpo de la respuesta debe estar en una pretty-print formato.	`false`
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 una lista de resultados, el objeto `content` es un sobre. Ops Manager agrega el campo `status` al cuerpo de la respuesta.	`false`

ageLimit	entero	Opcional	Tiempo en días para recuperar entradas para el archivo de diagnóstico.	7
limit	entero	Opcional	Número máximo de entradas para el archivo de diagnóstico.	1000
minutos	entero	Opcional	Rango de tiempo del fichero de diagnóstico, que comienza en el número especificado de minutos en el pasado y termina en el momento presente. Por ejemplo, para recuperar un archivo de diagnóstico con datos de los últimos 10 minutos, especifique `minutes=10` en su solicitud.	1440
sizeLimit	entero	Opcional	Tamaño máximo de cada archivo en el archivo de diagnóstico expresado en número de caracteres. Esto incluye valores hasta el valor entero más cercano a este límite.	50000000

Parámetros del cuerpo de la solicitud

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Respuesta

Este endpoint devuelve un archivo comprimido de tipo (.tar.gz) en tu directorio de trabajo actual con el nombre que especificaste usando la opción --output o -o.

Solicitud de ejemplo

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/gzip" \
     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/diagnostics?pretty=true" \
     --output project_diagnostics.tar.gz

La respuesta guarda project_diagnostics.tar.gz en el directorio de trabajo actual en tu host local.

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 archivo comprimido de tipo (.tar.gz) en tu directorio de trabajo actual con el nombre que especificaste usando la opción --output o -o.

Volver

Uso del servidor

Obtener el archivo de informes de uso global