/ /

/ /

Gerente de Operaciones

API

Recursos

Uso del servidor

Obtenga un archivo de informes de uso global

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

Roles necesarios

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

Solicitud

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

GET /usage/report

Parámetros de la ruta de solicitud

Este punto final no utiliza parámetros de ruta de solicitud HTTP.

Parámetros de consulta de solicitud

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonita

booleano

Opcional

Bandera que indica si el cuerpo de la respuesta debe estar en un impresión bonita formato.

false

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:

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

false

fecha de inicio	string	Requerido	Fecha en formato de 8601 fecha ISO en que se inicia el informe.
fecha de finalización	string	Requerido	Fecha en formato de fecha ISO 8601 en la que finaliza el informe.
fileFormat	String	Requerido	Formato de compresión del informe resultante. Ops Manager acepta archivos ZIP o .tar.gz.
redact	Booleano	Opcional	Bandera 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 punto final no utiliza parámetros del cuerpo de la solicitud HTTP.

Respuesta

Este punto final devuelve un .zip .tar.gz archivo comprimido o según su parámetro fileFormat.

Ejemplo de solicitud

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"

Ejemplo de respuesta

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}

Cuerpo de respuesta

Este punto final devuelve un .zip .tar.gz archivo comprimido o según su parámetro fileFormat.

Volver

Obtener archivo de diagnóstico

Lista de asignaciones de host