Recupere un informe comprimido, en formato zip o .tar.gz, del uso del servidor en un periodo de tiempo determinado.
Roles necesarios
Tu clave API debe tener el rol Global Owner para llamar correctamente a este recurso.
Solicitud
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /usage/reportPará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 muestra si el cuerpo de la respuesta está en formato pretty-print. |
|
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, ajusta envelope=true en la query. Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:
|
|
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 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
Este endpoint devuelve un archivo comprimido .zip o .tar.gz según tu parámetro fileFormat.