/ /

/ /

Gerente de Operaciones

API

Recursos

Uso del servidor

Obtén un informe global de uso de fichero

Recupere un informe comprimido, en formato zip o .tar.gz, del uso del servidor en un periodo de tiempo determinado.

Roles necesarios

Tu clave de API debe tener la Global Owner rol para llamar exitosamente a este recurso.

Solicitud

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

GET /usage/report

Parámetros de ruta de solicitud

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

Parámetros de Solicitud Query

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonito

booleano

Opcional

Indicador que señala si el cuerpo de la respuesta debe estar en un pretty-print formato.

false

envelope

booleano

Opcional

Bandera que indica si se debe o no envolver la respuesta en un sobre.

Algunos Los clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar este problema, configure envelope=true en la query.

Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre	Descripción
`status`	Código de respuesta HTTP
`content`	Cuerpo de respuesta esperado

false

startDate	string	Requerido	Fecha en ISO 8601 formato de fecha cuando el reporte comienza.
endDate	string	Requerido	Fecha en formato de fecha ISO 8601 cuando termina el informe.
fileFormat	String	Requerido	Formato de compresión del informe resultante. Ops Manager acepta zip o .tar.gz.
redact	Booleano	Opcional	Marca que indica si la respuesta debe censurar todas las direcciones IP, nombres de host, nombres de organizaciones y nombres de proyectos en el informe.	true

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 .zip o .tar.gz según tu parámetro fileFormat.

Solicitud de ejemplo

curl --user "{publicApiKey}:{privateApiKey}" --digest \
     --header "Accept: application/gzip" \
     --include \
     --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/usage/report?startDate=2019-07-27&endDate=2020-07-28&fileFormat=zip"

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 .zip o .tar.gz según tu parámetro fileFormat.

Volver

Obtener fichero de diagnóstico

Listado de Asignaciones de Host